Class DataProviderID

  • All Implemented Interfaces:
    Comparable<DataProviderID>

    public final class DataProviderID
    extends Object
    implements Comparable<DataProviderID>
    A unique ID which can be used for identifying data providers.

    There are two types of data provider:

    • User configured: these are data providers which have been defined using the server's configuration.
    • Internal: these are data providers which have been created internally.
    • Method Detail

      • newInternalID

        public static DataProviderID newInternalID​(String name)
        Creates a new ID for an internal data provider.
        Parameters:
        name - The name of the internal data provider.
        Returns:
        The new data provider ID.
      • newUserID

        public static DataProviderID newUserID​(String name)
        Creates a new ID for a user configured data provider.
        Parameters:
        name - The name of the user configured data provider.
        Returns:
        The new data provider ID.
      • getName

        public String getName()
        Returns the data provider name associated with this data provider ID.
        Returns:
        The data provider name associated with this data provider ID.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isInternal

        public boolean isInternal()
        Indicating whether this ID represents an internal data provider.
        Returns:
        true if this ID represents an internal data provider.