Package org.openstreetmap.josm.actions
Class ActionParameter<T>
- java.lang.Object
-
- org.openstreetmap.josm.actions.ActionParameter<T>
-
- Type Parameters:
T
- the value type
- Direct Known Subclasses:
ActionParameter.StringActionParameter
,SearchAction.SearchSettingsActionParameter
public abstract class ActionParameter<T> extends java.lang.Object
Abstract class for key=value parameters, used inParameterizedAction
.The key (
name
) is a string and the value of classT
. The value can be converted to and from a string.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActionParameter.StringActionParameter
Simple ActionParameter implementation for string values.
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
name
-
Constructor Summary
Constructors Modifier Constructor Description protected
ActionParameter(java.lang.String name)
Constructs a new ActionParameter.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
Get the name of this action parameter.abstract java.lang.Class<T>
getType()
Get the value type of this action parameter.abstract T
readFromString(java.lang.String s)
Create a value from the given string representation (deserialization).abstract java.lang.String
writeToString(T value)
Convert a given value into a string (serialization).
-
-
-
Field Detail
-
name
private final java.lang.String name
-
-
Constructor Detail
-
ActionParameter
protected ActionParameter(java.lang.String name)
Constructs a new ActionParameter.- Parameters:
name
- parameter name (the key)
-
-
Method Detail
-
getName
public java.lang.String getName()
Get the name of this action parameter. The name is used as a key, to look up values for the parameter.- Returns:
- the name of this action parameter
-
getType
public abstract java.lang.Class<T> getType()
Get the value type of this action parameter.- Returns:
- the value type of this action parameter
-
writeToString
public abstract java.lang.String writeToString(T value)
Convert a given value into a string (serialization).- Parameters:
value
- the value- Returns:
- a string representation of the value
-
readFromString
public abstract T readFromString(java.lang.String s)
Create a value from the given string representation (deserialization).- Parameters:
s
- the string representation of the value- Returns:
- the corresponding value object
-
-