Class ScimAttributeDefinition

java.lang.Object
com.revetsec.scim.ScimAttributeDefinition

@Immutable @CheckReturnValue public final class ScimAttributeDefinition extends Object
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
  • Method Details

    • withName

      Starts a definition for a bounded attribute name. The special $ref is 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

      Returns the canonical attribute name.
      Returns:
      the canonical attribute name
      Since:
      1.0.0
    • 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

      public boolean equals(@Nullable Object other)
      Compares semantic attribute characteristics, folding only the structural name.
      Overrides:
      equals in class Object
      Parameters:
      other - the comparison value
      Returns:
      whether the definitions have equal characteristics
      Since:
      1.0.0
    • hashCode

      public int hashCode()
      Returns the hash of semantic attribute characteristics.
      Overrides:
      hashCode in class Object
      Returns:
      the semantic hash
      Since:
      1.0.0
    • toString

      Returns a fixed description without configured schema data.
      Overrides:
      toString in class Object
      Returns:
      a fixed redacted description
      Since:
      1.0.0