Class SurfaceInfoType<T>

  • Type Parameters:
    T - the type of the associated value
    All Implemented Interfaces:
    Named, java.io.Serializable, java.lang.Comparable<SurfaceInfoType<T>>

    public final class SurfaceInfoType<T>
    extends TypedString<SurfaceInfoType<T>>
    The type that provides meaning to additional surface information.

    Additional surface information is stored in SurfaceMetadata. It provides the ability to associate arbitrary information with a surface in a key-value map. For example, it might be used to provide information about one of the axes.

    Applications that wish to use surface information should declare a static constant declaring the SurfaceInfoType instance, the type parameter and an UpperCamelCase name. For example:

      public static final SurfaceInfoType<String> OWNER = SurfaceInfoType.of("Owner");
     
    See Also:
    Serialized Form
    • Method Detail

      • of

        public static <T> SurfaceInfoType<T> of​(java.lang.String name)
        Obtains an instance from the specified name.

        The name may contain any character, but must not be empty.

        Type Parameters:
        T - the type associated with the info
        Parameters:
        name - the name
        Returns:
        a type instance with the specified name