org.kuali.rice.core.api.parameter
Class ParameterKey

java.lang.Object
  org.kuali.rice.core.api.parameter.ParameterKey

All Implemented Interfaces:

Serializable

public final class ParameterKey
extends Object
implements Serializable

This class represents the 4-part key which uniquely identifies a parameter.

See Also:

ParameterContract, Parameter, Serialized Form

Nested Class Summary

(package private) static class	ParameterKey.Constants Defines some internal constants used on this class.
(package private) static class	ParameterKey.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Field Summary

private Collection<Element>	_futureElements
private String	applicationId
private String	componentCode
private String	name
private String	namespaceCode
private static long	serialVersionUID

Constructor Summary

private	ParameterKey() This constructor should never be called except during JAXB unmarshalling.
private	ParameterKey(String applicationId, String namespaceCode, String componentCode, String name) Constructs a ParameterKey from the given values.

Method Summary

static ParameterKey	create(String applicationId, String namespaceCode, String componentCode, String name) Creates a ParameterKey from the given required values.
boolean	equals(Object obj)
String	getApplicationId()
String	getComponentCode()
String	getName()
String	getNamespaceCode()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

applicationId

private final String applicationId

namespaceCode

private final String namespaceCode

componentCode

private final String componentCode

name

private final String name

_futureElements

private final Collection<Element> _futureElements

Constructor Detail

ParameterKey

private ParameterKey()

This constructor should never be called except during JAXB unmarshalling.

ParameterKey

private ParameterKey(String applicationId,
                     String namespaceCode,
                     String componentCode,
                     String name)

Constructs a ParameterKey from the given values.

Method Detail

create

public static ParameterKey create(String applicationId,
                                  String namespaceCode,
                                  String componentCode,
                                  String name)

Creates a ParameterKey from the given required values.

Parameters:

applicationId - the application id, cannot be null or blank

namespaceCode - the namespace code, cannot be null or blank

componentCode - the component code, cannot be null or blank

name - the parameter name, cannot be null or blank

Returns:

the fully-constructed ParameterKey

Throws:

IllegalArgumentException - if any arguments are null or blank

getApplicationId

public String getApplicationId()

getNamespaceCode

public String getNamespaceCode()

getComponentCode

public String getComponentCode()

getName

public String getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object