Class ConstantInitializer<T>
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.lang3.concurrent.ConstantInitializer<T>
- Type Parameters:
T
- the type of the object managed by this initializer
- All Implemented Interfaces:
ConcurrentInitializer<T>
A very simple implementation of the ConcurrentInitializer
interface
which always returns the same object.
An instance of this class is passed a reference to an object when it is
constructed. The get()
method just returns this object. No
synchronization is required.
This class is useful for instance for unit testing or in cases where a
specific object has to be passed to an object which expects a
ConcurrentInitializer
.
- Since:
- 3.0
-
Constructor Summary
ConstructorDescriptionConstantInitializer
(T obj) Creates a new instance ofConstantInitializer
and initializes it with the object to be managed. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares this object with another one.get()
Returns the object managed by this initializer.final T
Directly returns the object that was passed to the constructor.int
hashCode()
Returns a hash code for this object.toString()
Returns a string representation for this object.
-
Constructor Details
-
ConstantInitializer
Creates a new instance ofConstantInitializer
and initializes it with the object to be managed. Theget()
method will always return the object passed here. This class does not place any restrictions on the object. It may be null, thenget()
will return null, too.- Parameters:
obj
- the object to be managed by this initializer
-
-
Method Details
-
getObject
Directly returns the object that was passed to the constructor. This is the same object as returned byget()
. However, this method does not declare that it throws an exception.- Returns:
- the object managed by this initializer
-
get
Returns the object managed by this initializer. This implementation just returns the object passed to the constructor.- Specified by:
get
in interfaceConcurrentInitializer<T>
- Returns:
- the object managed by this initializer
- Throws:
ConcurrentException
- if an error occurs
-
hashCode
public int hashCode()Returns a hash code for this object. This implementation returns the hash code of the managed object. -
equals
Compares this object with another one. This implementation returns true if and only if the passed in object is an instance ofConstantInitializer
which refers to an object equals to the object managed by this instance. -
toString
Returns a string representation for this object. This string also contains a string representation of the object managed by this initializer.
-