Record Class CollectorId
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.realtime.CollectorId
Identifies a data collector by a string id and a
CollectionMode.-
Constructor Summary
ConstructorsConstructorDescriptionCollectorId(String id, CollectionMode mode) Creates an instance of aCollectorIdrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.static CollectorIdfromString(String id, CollectionMode mode) Creates an id from a string.static CollectorIdfromUuid(UUID uuid, CollectionMode mode) Creates an id from a UUID.final inthashCode()Returns a hash code value for this object.id()Returns the value of theidrecord component.mode()Returns the value of themoderecord component.static CollectorIdrandom(CollectionMode mode) Creates an id with a random UUID.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
CollectorId
Creates an instance of aCollectorIdrecord class.- Parameters:
id- the value for theidrecord componentmode- the value for themoderecord component
-
-
Method Details
-
random
Creates an id with a random UUID.- Parameters:
mode- the collection mode- Returns:
- the id
-
fromUuid
Creates an id from a UUID.- Parameters:
uuid- the UUID to use as the identifiermode- the collection mode- Returns:
- the id
-
fromString
Creates an id from a string.- Parameters:
id- the string identifiermode- the collection mode- Returns:
- the id
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object). -
id
Returns the value of theidrecord component.- Returns:
- the value of the
idrecord component
-
mode
Returns the value of themoderecord component.- Returns:
- the value of the
moderecord component
-