Package org.opengis.test
Class Configuration
- Object
-
- Configuration
-
- All Implemented Interfaces:
Serializable
public class Configuration extends Object implements Serializable
Contains information about the test environment, like available factories and disabled tests.Configuration
is used in two places:- Before each test is executed,
ImplementationDetails
can provide configuration information. For example an implementation can declare that it does not support the calculation of transform derivative. - After each test is executed,
TestListener
can obtain the actual configuration used by the test. For example listeners can know whichFactory
instances were used.
get
,put
andremove
methods similar to those of thejava.util.Map
interface, with the addition of type-safety. The pre-defined keys are listed below:- Since:
- 3.1
- See Also:
TestCase.configuration()
,ImplementationDetails.configuration(Factory[])
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Configuration.Key<T>
Type-safe keys that can be used in aConfiguration
map.
-
Constructor Summary
Constructors Constructor Description Configuration()
Creates a new, initially empty, configuration map.Configuration(Configuration toCopy)
Creates a new configuration with the same mappings as the specified configuration.
-
Method Summary
Modifier and Type Method Description boolean
equals(Object other)
Compares this configuration with the given object for equality.<T> T
get(Configuration.Key<T> key)
Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.int
hashCode()
Returns a hash code value for this configuration map.Map<Configuration.Key<?>,Object>
map()
Returns all entries as an unmodifiable map.<T> T
put(Configuration.Key<T> key, T value)
Associates the specified value with the specified key in this map.<T> T
remove(Configuration.Key<T> key)
Removes the mapping for a key from this map if it is present.String
toString()
Returns a string representation of this configuration map.void
unsupported(Configuration.Key<Boolean>... operations)
Declares that all given operations are unsupported.
-
-
-
Constructor Detail
-
Configuration
public Configuration()
Creates a new, initially empty, configuration map.
-
Configuration
public Configuration(Configuration toCopy)
Creates a new configuration with the same mappings as the specified configuration.- Parameters:
toCopy
- the configuration whose mappings are to be placed in this map.- Throws:
NullPointerException
- if the specified configuration is null.
-
-
Method Detail
-
get
public <T> T get(Configuration.Key<T> key)
Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.- Type Parameters:
T
- the value type, which is determined by the key.- Parameters:
key
- the key whose associated value is to be returned.- Returns:
- the value to which the specified key is mapped, or
null
if this map contains no mapping for the key. - Throws:
NullPointerException
- if the specified key is null.
-
remove
public <T> T remove(Configuration.Key<T> key)
Removes the mapping for a key from this map if it is present.- Type Parameters:
T
- the value type, which is determined by the key.- Parameters:
key
- the key whose associated value is to be removed.- Returns:
- the value which was previously mapped to the specified key, or
null
. - Throws:
NullPointerException
- if the specified key is null.
-
put
public <T> T put(Configuration.Key<T> key, T value)
Associates the specified value with the specified key in this map.- Type Parameters:
T
- the value type, which is determined by the key.- Parameters:
key
- the key with which the specified value is to be associated.value
- the value to be associated with the specified key (can benull
).- Returns:
- the previous value associated with
key
, ornull
if there was no mapping for that key. - Throws:
NullPointerException
- if the specified key is null.
-
unsupported
@SafeVarargs public final void unsupported(Configuration.Key<Boolean>... operations)
Declares that all given operations are unsupported. This is a convenience method invokingput(key, Boolean.False)
for all operations given in argument.- Parameters:
operations
- the operations to declare as unsupported.- Throws:
NullPointerException
- if a specified key is null.
-
map
public Map<Configuration.Key<?>,Object> map()
Returns all entries as an unmodifiable map.- Returns:
- a map view over the entries in this
Configuration
object.
-
hashCode
public int hashCode()
Returns a hash code value for this configuration map.
-
equals
public boolean equals(Object other)
Compares this configuration with the given object for equality.
-
-