Interface Type

  • All Known Subinterfaces:
    WriteableType
    All Known Implementing Classes:
    TypeImpl, WriteableTypeImpl

    public interface Type
    A type contains (possibly) multiple instances of a configuration bean
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Instance getInstance​(java.lang.String key)
      Gets the instance associated with this key, or null if there is none
      java.util.Map<java.lang.String,​Instance> getInstances()
      Returns a read-only map of the instances that are associated with this type
      java.lang.Object getMetadata()
      Gets information about this type.
      java.lang.String getName()
      A unique identifier for this type
      void setMetadata​(java.lang.Object metadata)
      Sets an object containing information about this type.
    • Method Detail

      • getName

        java.lang.String getName()
        A unique identifier for this type
        Returns:
        A unique identifier for this type (may not return null)
      • getInstances

        java.util.Map<java.lang.String,​Instance> getInstances()
        Returns a read-only map of the instances that are associated with this type
        Returns:
        A read-only and possibly empty map of instances associated with this type
      • getInstance

        Instance getInstance​(java.lang.String key)
        Gets the instance associated with this key, or null if there is none
        Parameters:
        key - The non-null key for the instance
        Returns:
        The resulting instance or null if there is none
      • getMetadata

        java.lang.Object getMetadata()
        Gets information about this type. Can be used to describe the type in some useful way
        Returns:
        The possibly null metadata associated with this type
      • setMetadata

        void setMetadata​(java.lang.Object metadata)
        Sets an object containing information about this type. Can be used to describe the type in some useful way
        Parameters:
        metadata - The possibly null metadata to be associated with this type