Typparameter:
T - type parameter
Alle Superschnittstellen:
Collection<DomainKey<T>>, Iterable<DomainKey<T>>
Alle bekannten Implementierungsklassen:
DefaultCompositeKey

public interface CompositeKey<T> extends Collection<DomainKey<T>>
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.
  • Methodendetails

    • encodeToString

      String encodeToString() throws EncoderException
      Encode cluster key as string or null.
      Gibt zurück:
      the encoded cluster key or null
      Löst aus:
      EncoderException - if encoding fails
    • encodeToURI

      URI encodeToURI(String prefix) throws URISyntaxException, EncoderException
      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 URI
      EncoderException - if encoding fails
    • getComponent

      DomainKey<T> getComponent(Domain domain)
      Get component for a given domain.
      Parameter:
      domain - the domain
      Gibt zurück:
      the cluster key component
    • update

      void update(DomainKey<T> component)
      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