Package org.geotools.parameter
Class AbstractParameter
Object
Formattable
AbstractParameter
- All Implemented Interfaces:
Serializable
,Cloneable
,GeneralParameterValue
,Cloneable
- Direct Known Subclasses:
FloatParameter
,ImagingParameters
,Parameter
,ParameterGroup
public abstract class AbstractParameter
extends Formattable
implements GeneralParameterValue, Serializable
Abstract parameter value or group of parameter values.
- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD)
- See Also:
-
Field Summary
Fields inherited from class Formattable
SINGLE_LINE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractParameter
(GeneralParameterDescriptor descriptor) Constructs a parameter value from the specified descriptor. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a copy of this parameter value or group.boolean
Compares the specified object with this parameter for equality.protected final String
Format the inner part of this parameter as Well Known Text (WKT).Returns the abstract definition of this parameter or group of parameters.int
hashCode()
Returns a hash value for this parameter.final String
toString()
Returns a string representation of this parameter.protected void
write
(TableWriter table) Write the content of this parameter to the specified table.Methods inherited from class Formattable
cleanupThreadLocals, toWKT, toWKT, toWKT, toWKT
-
Constructor Details
-
AbstractParameter
Constructs a parameter value from the specified descriptor.- Parameters:
descriptor
- The abstract definition of this parameter or group of parameters.
-
-
Method Details
-
getDescriptor
Returns the abstract definition of this parameter or group of parameters.- Specified by:
getDescriptor
in interfaceGeneralParameterValue
- Returns:
- The abstract definition of this parameter or group of parameters.
-
clone
Returns a copy of this parameter value or group. -
equals
Compares the specified object with this parameter for equality. -
hashCode
public int hashCode()Returns a hash value for this parameter. This value doesn't need to be the same in past or future versions of this class. -
toString
Returns a string representation of this parameter. The default implementation delegates the work towrite(org.geotools.util.TableWriter)
, which should be overridden by subclasses.- Overrides:
toString
in classFormattable
-
write
Write the content of this parameter to the specified table. This method make it easier to align values properly than overriding thetoString()
method. The table's columns are defined as below:- The parameter name
- The separator
- The parameter value
The default implementation is suitable for most cases. However, subclasses are free to override this method with the following idiom:
table.write("parameter name"); table.nextColumn() table.write('='); table.nextColumn() table.write("parameter value"); table.nextLine()
- Parameters:
table
- The table where to format the parameter value.- Throws:
IOException
- if an error occurs during output operation.
-
formatWKT
Format the inner part of this parameter as Well Known Text (WKT). This method doesn't need to be overridden, since the formatter already know how to format parameters.- Overrides:
formatWKT
in classFormattable
- Parameters:
formatter
- The formatter to use.- Returns:
- The name of the WKT element type (e.g.
"GEOGCS"
). - See Also:
-