de.smartics.properties.api.config.domain.key
Class ConfigurationKey

java.lang.Object
  de.smartics.properties.api.config.domain.key.ConfigurationKey

All Implemented Interfaces:

Serializable, Comparable< ConfigurationKey>

public final class ConfigurationKey
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable, 
      
      Comparable<
      
      ConfigurationKey>
     
     

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

See Also:

Serialized Form

Constructor Summary

ConfigurationKey(EnvironmentId environmentId, ApplicationId applicationId)
Default constructor.

Method Summary

int	compareTo(ConfigurationKey o)
boolean	equals(Object object) Returns true if the given object is semantically equal to the given object, false otherwise.
ApplicationId	getApplicationId() Returns the identifier of the application whose configuration is requested.
EnvironmentId	getEnvironmentId() Returns the identifier of the environment the application is deployed in.
int	hashCode() Returns the hash code of the object.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationKey

public ConfigurationKey(EnvironmentId environmentId,
                        ApplicationId applicationId)
                 throws de.smartics.util.lang.NullArgumentException

Default constructor.

Parameters:

applicationId - the identifier of the application whose configuration is requested.

environmentId - the identifier of the environment the application is deployed in.

Throws:

de.smartics.util.lang.NullArgumentException - if applicationId or environmentId is null.

Method Detail

getEnvironmentId

public EnvironmentId getEnvironmentId()

Returns the identifier of the environment the application is deployed in.

Returns:

the identifier of the environment the application is deployed in.

getApplicationId

public ApplicationId getApplicationId()

Returns the identifier of the application whose configuration is requested.

Returns:

the identifier of the application whose configuration is requested.

hashCode

public int hashCode()

Returns the hash code of the object.

Overrides:

hashCode in class Object

Returns:

the hash code.

equals

public 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

public int compareTo(ConfigurationKey o)

Specified by:

compareTo in interface Comparable<ConfigurationKey>

See Also:

Comparable.compareTo(java.lang.Object)

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string representation of the object.