Package org.codehaus.jackson.map.type

Class CollectionLikeType

  • All Implemented Interfaces:
    JsonSerializable, JsonSerializableWithType
    Direct Known Subclasses:
    CollectionType
    public class CollectionLikeType
extends TypeBase
    Type that represents things that act similar to Collection; but may or may not be instances of that interface. This specifically allows framework to check for configuration and annotation settings used for Map types, and pass these to custom handlers that may be more familiar with actual type.
    Since:
    1.8

    • Field Detail

      • _elementType

        protected final JavaType _elementType
        Type of elements in collection

    • Constructor Detail

      • CollectionLikeType

        @Deprecated
protected CollectionLikeType​(java.lang.Class<?> collT,
                             JavaType elemT)
        Deprecated.

      • CollectionLikeType

        protected CollectionLikeType​(java.lang.Class<?> collT,
                             JavaType elemT,
                             java.lang.Object valueHandler,
                             java.lang.Object typeHandler)

    • Method Detail

      • withTypeHandler

        public CollectionLikeType withTypeHandler​(java.lang.Object h)
        Description copied from class: JavaType
        "Copy method" that will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.
        Specified by:
        withTypeHandler in class JavaType
        Returns:
        Newly created type instance

      • withContentTypeHandler

        public CollectionLikeType withContentTypeHandler​(java.lang.Object h)
        Description copied from class: JavaType
        "Copy method" that will construct a new instance that is identical to this instance, except that its content type will have specified type handler assigned.
        Specified by:
        withContentTypeHandler in class JavaType
        Returns:
        Newly created type instance

      • isContainerType

        public boolean isContainerType()
        Specified by:
        isContainerType in class JavaType
        Returns:
        True if type represented is a container type; this includes array, Map and Collection types.

      • isCollectionLikeType

        public boolean isCollectionLikeType()
        Overrides:
        isCollectionLikeType in class JavaType
        Returns:
        True if type is either true Collection type, or something similar (meaning it has at least one type parameter, which describes type of contents)

      • getContentType

        public JavaType getContentType()
        Description copied from class: JavaType
        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

      • containedTypeCount

        public int containedTypeCount()
        Description copied from class: JavaType
        Method for checking how many contained types this type has. Contained types are usually generic types, so that generic Maps have 2 contained types.
        Overrides:
        containedTypeCount in class JavaType

      • containedType

        public JavaType containedType​(int index)
        Description copied from class: JavaType
        Method for accessing definitions of contained ("child") types.
        Overrides:
        containedType in class JavaType
        Parameters:
        index - Index of contained type to return
        Returns:
        Contained type at index, or null if no such type exists (no exception thrown)

      • containedTypeName

        public java.lang.String containedTypeName​(int index)
        Not sure if we should count on this, but type names for core interfaces use "E" for element type
        Overrides:
        containedTypeName in class JavaType
        Parameters:
        index - Index of contained type to return
        Returns:
        Contained type at index, or null if no such type exists (no exception thrown)

      • getErasedSignature

        public java.lang.StringBuilder getErasedSignature​(java.lang.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.
        Specified by:
        getErasedSignature in class TypeBase
        Parameters:
        sb - StringBuilder to append signature to
        Returns:
        StringBuilder that was passed in; returned to allow call chaining

      • getGenericSignature

        public java.lang.StringBuilder getGenericSignature​(java.lang.StringBuilder sb)
        Specified by:
        getGenericSignature in class TypeBase
        Parameters:
        sb - StringBuilder to append signature to
        Returns:
        StringBuilder that was passed in; returned to allow call chaining

      • isTrueCollectionType

        public boolean isTrueCollectionType()
        Method that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype of Collection or just something that acts like one.
        Since:
        1.8

      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in class JavaType

      • toString

        public java.lang.String toString()
        Specified by:
        toString in class JavaType