Package edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.type

Class ReferenceType

java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.type.ResolvedType
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.type.TypeBase
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.type.SimpleType
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.type.ReferenceType
All Implemented Interfaces:
JsonSerializable, Serializable, Type
public class ReferenceType extends SimpleType
Specialized SimpleType for types that are referential types, that is, values that can be dereferenced to another value (or null), of different type. Referenced type is accessible using getContentType().
Since:
2.6
See Also:

  • Field Details

    • _referencedType

      protected final JavaType _referencedType

    • _anchorType

      protected final JavaType _anchorType
      Essential type used for type ids, for example if type id is needed for referencing type with polymorphic handling. Typically initialized when a SimpleType is upgraded into reference type, but NOT changed if being sub-classed.
      Since:
      2.8

  • Constructor Details

  • Method Details

    • upgradeFrom

      public static ReferenceType upgradeFrom(JavaType baseType, JavaType refdType)
      Factory method that can be used to "upgrade" a basic type into collection-like one; usually done via TypeModifier
      Parameters:
      baseType - Resolved non-reference type (usually SimpleType) that is being upgraded
      refdType - Referenced type; usually the first and only type parameter, but not necessarily
      Since:
      2.7

    • construct

      public static ReferenceType construct(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType refType)
      Since:
      2.7

    • construct

      @Deprecated public static ReferenceType construct(Class<?> cls, JavaType refType)
      Deprecated.

    • withContentType

      public JavaType withContentType(JavaType contentType)
      Description copied from class: JavaType
      Mutant factory method that may be called on structured types that have a so-called content type (element of arrays, value type of Maps, referenced type of referential types), and will construct a new instance that is identical to this instance, except that it has specified content type, instead of current one. If content type is already set to given type, this is returned. If type does not have a content type (which is the case with SimpleType), IllegalArgumentException will be thrown.
      Overrides:
      withContentType in class SimpleType
      Returns:
      Newly created type instance

    • withTypeHandler

      public ReferenceType withTypeHandler(Object h)
      Description copied from class: JavaType
      Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.

      This mutant factory method will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.

      Overrides:
      withTypeHandler in class SimpleType
      Parameters:
      h - Handler to pass to new instance created
      Returns:
      Newly created type instance with same type information, specified handler

    • withContentTypeHandler

      public ReferenceType withContentTypeHandler(Object h)
      Description copied from class: JavaType
      Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.

      This mutant factory method will construct a new instance that is identical to this instance, except that it will have specified content type (element type for arrays, value type for Maps and so forth) handler assigned.

      Overrides:
      withContentTypeHandler in class SimpleType
      Parameters:
      h - Handler to pass to new instance created
      Returns:
      Newly created type instance with same type information, specified handler

    • withValueHandler

      public ReferenceType withValueHandler(Object h)
      Description copied from class: JavaType
      Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.

      This mutant factory method will construct a new instance that is identical to this instance, except that it will have specified value handler assigned.

      Overrides:
      withValueHandler in class SimpleType
      Parameters:
      h - Handler to pass to new instance created
      Returns:
      Newly created type instance with same type information, specified handler

    • withContentValueHandler

      public ReferenceType withContentValueHandler(Object h)
      Description copied from class: JavaType
      Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.

      Mutant factory method that will construct a new instance that is identical to this instance, except that it will have specified content value handler assigned.

      Overrides:
      withContentValueHandler in class SimpleType
      Parameters:
      h - Handler to pass to new instance created
      Returns:
      Newly created type instance with same type information, specified handler

    • withStaticTyping

      public ReferenceType withStaticTyping()
      Description copied from class: JavaType
      Method that can be called to get a type instance that indicates that values of the type should be handled using "static typing" for purposes of serialization (as opposed to "dynamic" aka runtime typing): meaning that no runtime information is needed for determining serializers to use. The main use case is to allow forcing of specific root value serialization type, and specifically in resolving serializers for contained types (element types for arrays, Collections and Maps).
      Overrides:
      withStaticTyping in class SimpleType

    • refine

      public JavaType refine(Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)
      Description copied from class: JavaType
      Mutant factory method that will try to create and return a sub-type instance for known parameterized types; for other types will return `null` to indicate that no just refinement makes necessary sense, without trying to detect special status through implemented interfaces.
      Overrides:
      refine in class SimpleType

    • buildCanonicalName

      protected String buildCanonicalName()
      Overrides:
      buildCanonicalName in class SimpleType

    • _narrow

      @Deprecated protected JavaType _narrow(Class<?> subclass)
      Deprecated.
      Overrides:
      _narrow in class SimpleType

    • getContentType

      public JavaType getContentType()
      Description copied from class: ResolvedType
      Method for accessing content type of this type, if type has such a thing: simple types do not, structured types do (like arrays, Collections and Maps)
      Overrides:
      getContentType in class JavaType
      Returns:
      Content type of this type, if any; null if none

    • getReferencedType

      public JavaType getReferencedType()
      Description copied from class: ResolvedType
      Method for accessing type of value that instances of this type references, if any.
      Overrides:
      getReferencedType in class JavaType
      Returns:
      Referenced type, if any; null if not.

    • hasContentType

      public boolean hasContentType()
      Description copied from class: JavaType
      Accessor that allows determining whether JavaType.getContentType() should return a non-null value (that is, there is a "content type") or not. True if JavaType.isContainerType() or ResolvedType.isReferenceType() return true.
      Overrides:
      hasContentType in class SimpleType

    • isReferenceType

      public boolean isReferenceType()
      Description copied from class: ResolvedType
      Whether this type is a referential type, meaning that values are basically pointers to "real" values (or null) and not regular values themselves. Typical examples include things like AtomicReference, and various Optional types (in JDK8, Guava).
      Overrides:
      isReferenceType in class ResolvedType
      Returns:
      True if this is a "referential" type, false if not

    • getErasedSignature

      public StringBuilder getErasedSignature(StringBuilder sb)
      Description copied from class: JavaType
      Method for accessing signature without generic type information, in form compatible with all versions of JVM, and specifically used for type descriptions when generating byte code.
      Overrides:
      getErasedSignature in class SimpleType
      Parameters:
      sb - StringBuilder to append signature to
      Returns:
      StringBuilder that was passed in; returned to allow call chaining

    • getGenericSignature

      public StringBuilder getGenericSignature(StringBuilder sb)
      Overrides:
      getGenericSignature in class SimpleType
      Parameters:
      sb - StringBuilder to append signature to
      Returns:
      StringBuilder that was passed in; returned to allow call chaining

    • getAnchorType

      public JavaType getAnchorType()

    • isAnchorType

      public boolean isAnchorType()
      Convenience accessor that allows checking whether this is the anchor type itself; if not, it must be one of supertypes that is also a ReferenceType

    • toString

      public String toString()
      Overrides:
      toString in class SimpleType

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class SimpleType