de.smartics.properties.api.config.domain.key
Interface ConfigurationKey<T extends ConfigurationKey<?>>

Type Parameters:

T - the implementing type of this interface.

All Superinterfaces:

Comparable<T>, Serializable

All Known Implementing Classes:

AbstractConfigurationKey, EnvAppConfigurationKey, TenantUserConfigurationKey

public interface ConfigurationKey<T extends ConfigurationKey<?>>
     
     

      
      extends 
      
      Serializable, 
      
      Comparable<T>
     
     

The configuration key identifies a configuration. With this key all configuration values can be accessed by their local configuration keys.

Method Summary

int	compareTo(T o)
boolean	equals(Object object) Returns true if the given object is semantically equal to the given object, false otherwise.
boolean	hasActiveDynamicParts() Returns true if this key instance has active dynamic parts.
int	hashCode() Returns the hash code of the object.
String	toString() Returns the string representation of the object.

Method Detail

hasActiveDynamicParts

boolean hasActiveDynamicParts()

Returns true if this key instance has active dynamic parts. Returns false (otherwise) if this key instance has only static parts. The decision criteria between a static and a dynamic key is, if all keys are known at startup, or if keys have dynamic parts, like the current user or the current tenant which can change during runtime.

Returns:

true when this key uses dynamic parts (and not only static parts). false otherwise.

hashCode

int hashCode()

Returns the hash code of the object.

Overrides:

hashCode in class Object

Returns:

the hash code.

equals

boolean equals(Object object)

Returns true if the given object is semantically equal to the given object, false otherwise.

Overrides:

equals in class Object

Parameters:

object - the instance to compare to.

Returns:

true if the given object is semantically equal to the given object, false otherwise.

compareTo

int compareTo(T o)

Specified by:

compareTo in interface Comparable<T extends ConfigurationKey<?>>

toString

String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.