Class ScimAttributeDefinition
java.lang.Object
com.revetsec.scim.ScimAttributeDefinition
Immutable SCIM attribute characteristics. Canonical values are suggested values, not an
enforced whitelist. Application-resource schemas permit only one complex attribute level.
- Since:
- 1.0.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classMutable, non-thread-safe definition configuration. -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompares semantic attribute characteristics, folding only the structural name.Returns the immutable suggested canonical values.Returns the optional description.Returns the write characteristic.getName()Returns the canonical attribute name.Returns the immutable allowed reference-type descriptions.Returns the response visibility characteristic.Returns the immutable subattribute definitions.getType()Returns the declared attribute type.Returns the application-enforced uniqueness characteristic.inthashCode()Returns the hash of semantic attribute characteristics.Returns whether string comparison is case exact.Returns whether the attribute is multi-valued.Returns whether assigned data is required.toString()Returns a fixed description without configured schema data.Starts a definition for a bounded attribute name.
-
Method Details
-
withName
Starts a definition for a bounded attribute name. The special$refis permitted here for subattributes, while a schema rejects it as a top-level application attribute.- Parameters:
name- the required name- Returns:
- a new builder
- Since:
- 1.0.0
-
getName
-
getType
Returns the declared attribute type.- Returns:
- the declared attribute type
- Since:
- 1.0.0
-
getDescription
Returns the optional description.- Returns:
- the optional description
- Since:
- 1.0.0
-
isMultiValued
Returns whether the attribute is multi-valued.- Returns:
- whether the attribute is multi-valued
- Since:
- 1.0.0
-
isRequired
Returns whether assigned data is required.- Returns:
- whether assigned data is required
- Since:
- 1.0.0
-
isCaseExact
Returns whether string comparison is case exact.- Returns:
- whether string comparison is case exact
- Since:
- 1.0.0
-
getMutability
Returns the write characteristic.- Returns:
- the write characteristic
- Since:
- 1.0.0
-
getReturned
Returns the response visibility characteristic.- Returns:
- the response visibility characteristic
- Since:
- 1.0.0
-
getUniqueness
Returns the application-enforced uniqueness characteristic.- Returns:
- the application-enforced uniqueness characteristic
- Since:
- 1.0.0
-
getCanonicalValues
Returns the immutable suggested canonical values.- Returns:
- the immutable suggested canonical values
- Since:
- 1.0.0
-
getReferenceTypes
Returns the immutable allowed reference-type descriptions.- Returns:
- the immutable allowed reference-type descriptions
- Since:
- 1.0.0
-
getSubAttributes
Returns the immutable subattribute definitions.- Returns:
- the immutable subattribute definitions
- Since:
- 1.0.0
-
equals
-
hashCode
-
toString
-