Package de.captaingoldfish.scim.sdk.common.resources.complex

Class Name

java.lang.Object
com.fasterxml.jackson.databind.JsonSerializable.Base
com.fasterxml.jackson.databind.JsonNode
com.fasterxml.jackson.databind.node.BaseJsonNode
com.fasterxml.jackson.databind.node.ContainerNode<com.fasterxml.jackson.databind.node.ObjectNode>
com.fasterxml.jackson.databind.node.ObjectNode
de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode
de.captaingoldfish.scim.sdk.common.resources.complex.Name
All Implemented Interfaces:
com.fasterxml.jackson.core.TreeNode, com.fasterxml.jackson.databind.JsonSerializable, com.fasterxml.jackson.databind.node.JsonNodeCreator, ScimNode, Serializable, Iterable<com.fasterxml.jackson.databind.JsonNode>
public class Name extends ScimObjectNode
author Pascal Knueppel
created at: 11.10.2019 - 10:19

The components of the user's name. Service providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Name.NameBuilder
    override lombok builder with public constructor

    Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonNode

    com.fasterxml.jackson.databind.JsonNode.OverwriteMode

    Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

    com.fasterxml.jackson.databind.JsonSerializable.Base

  • Field Summary

    Fields inherited from class com.fasterxml.jackson.databind.node.ObjectNode

    _children

    Fields inherited from class com.fasterxml.jackson.databind.node.ContainerNode

    _nodeFactory

  • Constructor Summary

    Constructors
    Constructor
    Description
    Name()
     
    Name(String formatted, String familyName, String givenName, String middlename, String honorificPrefix, String honorificSuffix)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Name.NameBuilder
    builder()
     
    Optional<String>
    getFamilyName()
    The family name of the User, or last name in most Western languages (e.g., "Jensen" given the full name "Ms.
    Optional<String>
    getFormatted()
    The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., "Ms.
    Optional<String>
    getGivenName()
    The given name of the User, or first name in most Western languages (e.g., "Barbara" given the full name "Ms.
    Optional<String>
    getHonorificPrefix()
    The honorific prefix(es) of the User, or title in most Western languages (e.g., "Ms." given the full name "Ms.
    Optional<String>
    getHonorificSuffix()
    The honorific suffix(es) of the User, or suffix in most Western languages (e.g., "III" given the full name "Ms.
    Optional<String>
    getMiddleName()
    The middle name(s) of the User (e.g., "Jane" given the full name "Ms.
    void
    setFamilyName(String familyName)
    The family name of the User, or last name in most Western languages (e.g., "Jensen" given the full name "Ms.
    void
    setFormatted(String formatted)
    The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., "Ms.
    void
    setGivenName(String givenName)
    The given name of the User, or first name in most Western languages (e.g., "Barbara" given the full name "Ms.
    void
    setHonorificPrefix(String honorificPrefix)
    The honorific prefix(es) of the User, or title in most Western languages (e.g., "Ms." given the full name "Ms.
    void
    setHonorificSuffix(String honorificSuffix)
    The honorific suffix(es) of the User, or suffix in most Western languages (e.g., "III" given the full name "Ms.
    void
    setMiddleName(String middleName)
    The middle name(s) of the User (e.g., "Jane" given the full name "Ms.

    Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

    addAttribute, getArrayAttribute, getBinaryAttribute, getBooleanAttribute, getDateTimeAttribute, getDoubleAttribute, getIntegerAttribute, getLongAttribute, getObjectAttribute, getSchemaAttribute, getSimpleArrayAttribute, getSimpleArrayAttribute, getSimpleArrayAttributeSet, getSimpleArrayAttributeSet, getStringAttribute, getStringAttribute, isEmpty, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeList, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setStringAttributeList, setStringAttributeList, toPrettyString, toString

    Methods inherited from class com.fasterxml.jackson.databind.node.ObjectNode

    _at, _childrenEqual, _put, _withArray, _withArrayAddTailProperty, _withObject, _withObjectAddTailProperty, asToken, deepCopy, elements, equals, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, get, get, getNodeType, hashCode, isEmpty, isObject, path, path, properties, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAll, putArray, putIfAbsent, putNull, putObject, putPOJO, putRawValue, remove, remove, removeAll, replace, required, retain, retain, serialize, serializeFilteredContents, serializeWithType, set, setAll, setAll, size, with, withArray, without, without

    Methods inherited from class com.fasterxml.jackson.databind.node.ContainerNode

    arrayNode, arrayNode, asText, binaryNode, binaryNode, booleanNode, missingNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, rawValueNode, textNode

    Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode

    _bigIntFromBigDec, _jsonPointerIfValid, _reportWrongNodeOperation, _reportWrongNodeType, _withXxxMayReplace, _withXxxVerifyReplace, findPath, numberType, required, traverse, traverse, withArray, withObject

    Methods inherited from class com.fasterxml.jackson.databind.JsonNode

    _reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, canConvertToInt, canConvertToLong, decimalValue, doubleValue, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, withArray, withArray, withObject, withObject, withObject

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface de.captaingoldfish.scim.sdk.common.resources.base.ScimNode

    getAttributeDescription, getAttributeName, getCanonicalValues, getMutability, getReferenceTypes, getReturned, getScimNodeName, getUniqueness, getValueType, isCaseExact, isMultiValued, isRequired

  • Constructor Details

  • Method Details

    • getFormatted

      public Optional<String> getFormatted()
      The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., "Ms. Barbara Jane Jensen, III").

    • setFormatted

      public void setFormatted(String formatted)
      The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., "Ms. Barbara Jane Jensen, III").

    • getFamilyName

      public Optional<String> getFamilyName()
      The family name of the User, or last name in most Western languages (e.g., "Jensen" given the full name "Ms. Barbara Jane Jensen, III").

    • setFamilyName

      public void setFamilyName(String familyName)
      The family name of the User, or last name in most Western languages (e.g., "Jensen" given the full name "Ms. Barbara Jane Jensen, III").

    • getGivenName

      public Optional<String> getGivenName()
      The given name of the User, or first name in most Western languages (e.g., "Barbara" given the full name "Ms. Barbara Jane Jensen, III").

    • setGivenName

      public void setGivenName(String givenName)
      The given name of the User, or first name in most Western languages (e.g., "Barbara" given the full name "Ms. Barbara Jane Jensen, III").

    • getMiddleName

      public Optional<String> getMiddleName()
      The middle name(s) of the User (e.g., "Jane" given the full name "Ms. Barbara Jane Jensen, III").

    • setMiddleName

      public void setMiddleName(String middleName)
      The middle name(s) of the User (e.g., "Jane" given the full name "Ms. Barbara Jane Jensen, III").

    • getHonorificPrefix

      public Optional<String> getHonorificPrefix()
      The honorific prefix(es) of the User, or title in most Western languages (e.g., "Ms." given the full name "Ms. Barbara Jane Jensen, III").

    • setHonorificPrefix

      public void setHonorificPrefix(String honorificPrefix)
      The honorific prefix(es) of the User, or title in most Western languages (e.g., "Ms." given the full name "Ms. Barbara Jane Jensen, III").

    • getHonorificSuffix

      public Optional<String> getHonorificSuffix()
      The honorific suffix(es) of the User, or suffix in most Western languages (e.g., "III" given the full name "Ms. Barbara Jane Jensen, III").

    • setHonorificSuffix

      public void setHonorificSuffix(String honorificSuffix)
      The honorific suffix(es) of the User, or suffix in most Western languages (e.g., "III" given the full name "Ms. Barbara Jane Jensen, III").

    • builder

      public static Name.NameBuilder builder()