Schnittstelle CompositeKey<T>
- Typparameter:
T
- type parameter
- Alle Superschnittstellen:
Collection<DomainKey<T>>
,Iterable<DomainKey<T>>
- Alle bekannten Implementierungsklassen:
DefaultCompositeKey
A ccomposite key holds one or more keys,
where the encoded key representations are used to generate a
uniform resource identifier.
The order of the keys is maintained as the order of adding keys.
A key can be updated or removed.
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungEncode cluster key as string or null.encodeToURI
(String prefix) Encode cluster key as a Uniform Resource Identifier.getComponent
(Domain domain) Get component for a given domain.boolean
Get usable flag.void
setUsable
(boolean usable) Set or unset usable flag.void
Update component.
-
Methodendetails
-
encodeToString
Encode cluster key as string or null.- Gibt zurück:
- the encoded cluster key or null
- Löst aus:
EncoderException
- if encoding fails
-
encodeToURI
Encode cluster key as a Uniform Resource Identifier.- Parameter:
prefix
- the URI prefix- Gibt zurück:
- the uri
- Löst aus:
URISyntaxException
- if a cluster key can not be constructed as an URIEncoderException
- if encoding fails
-
getComponent
Get component for a given domain.- Parameter:
domain
- the domain- Gibt zurück:
- the cluster key component
-
update
Update component.- Parameter:
component
- component
-
setUsable
void setUsable(boolean usable) Set or unset usable flag. This flag can invalidate the key, if the application decides the key should not be used, but retains the components.- Parameter:
usable
- true for uable
-
getUsable
boolean getUsable()Get usable flag.- Gibt zurück:
- true is usable
-