ParameterWrapper (JChem Base API documentation (c) 1998-2021 ChemAxon Ltd.)

java.lang.Object
- com.chemaxon.apidiscovery.ParameterWrapper

```
@Beta
 @PublicAPI
public class ParameterWrapper
extends java.lang.Object
```
Wraps a parameter which can be set or get on an object.
Usually parameters of Builder objects are wrapped

Please note that support of all types and validation is not complete yet.

Please note that this class is marked with Beta annotation, so it can be subject of incompatible changes or removal in later releases.

Author:

Gabor Imre

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ParameterWrapper.ParameterType
Wrapped parameter types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ParameterWrapper.ParameterType` Wrapped parameter types.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAPIFieldName()` API field name.
`boolean`	`getBooleanValue()` Value of a boolean field.
`java.lang.Object`	`getCurrentValue()` Current value.
`java.lang.Object`	`getCurrentValueOn(java.lang.Object o)` Current value on a different object.
`java.lang.String`	`getDetailedDescription()` Detailed description.
`double`	`getDoubleValue()` Value of a double field.
`java.lang.Class<? extends java.lang.Enum>`	`getEnumParameterClass()` Return enum class for enum field.
`java.lang.Enum`	`getEnumValue()` Value of an enum field.
`int`	`getIntValue()` Value of an int field.
`long`	`getLongValue()` Value of an long field.
`com.google.common.base.Optional<java.lang.Double>`	`getMaxDouble()` Largest possible floating point value for floating point fields.
`com.google.common.base.Optional<java.lang.Long>`	`getMaxLong()` Largest possible fixed point value for fixed point fields.
`com.google.common.base.Optional<java.lang.Double>`	`getMinDouble()` Smallest possible floating point value for floating point fields.
`com.google.common.base.Optional<java.lang.Long>`	`getMinLong()` Smallest possible fixed point value for fixed point fields.
`java.lang.String`	`getName()` Name.
`java.lang.Class<?>`	`getParameterClass()` Parameter field class.
`java.lang.String`	`getShortName()` Short name.
`java.lang.String`	`getStringValue()` Value of a String field.
`ParameterWrapper.ParameterType`	`getType()` Type.
`void`	`parseParameterValue(java.lang.String value)` Parse parameter value from a String.
`void`	`setBooleanValue(boolean b)` Set value of a boolean field.
`void`	`setDoubleValue(double d)` Set value of a double field.
`void`	`setIntValue(int i)` Set int value of a int field.
`void`	`setLongValue(long i)` Set long value of a long field.
`void`	`setStringValue(java.lang.String s)` Set String value of a String field.
`void`	`setValue(java.lang.Object o)` Set value.
`java.lang.String`	`toStringRepresentation()` Create String representation of the represented value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAPIFieldName
```
public java.lang.String getAPIFieldName()
```
    API field name.
    
    Returns:
    
    The API field name of the represented parameter
  - getShortName
```
public java.lang.String getShortName()
```
    Short name.
    
    Returns:
    
    Short name of the represented parameter - from its Description annotation
  - getName
```
public java.lang.String getName()
```
    Name.
    
    Returns:
    
    Name of the represented parameter - from its Description annotation
  - getDetailedDescription
```
public java.lang.String getDetailedDescription()
```
    Detailed description.
    
    Returns:
    
    Detailed description of the represented parameter - from its Description annotation
  - getMinDouble
```
public com.google.common.base.Optional<java.lang.Double> getMinDouble()
```
    Smallest possible floating point value for floating point fields.
    
    Returns:
    
    smallest possible floating point value if specified
  - getMaxDouble
```
public com.google.common.base.Optional<java.lang.Double> getMaxDouble()
```
    Largest possible floating point value for floating point fields.
    
    Returns:
    
    largest possible floating point value if specified
  - getMinLong
```
public com.google.common.base.Optional<java.lang.Long> getMinLong()
```
    Smallest possible fixed point value for fixed point fields.
    
    Returns:
    
    smallest possible fixed point value if specified
  - getMaxLong
```
public com.google.common.base.Optional<java.lang.Long> getMaxLong()
```
    Largest possible fixed point value for fixed point fields.
    
    Returns:
    
    largest possible fixed point value if specified
  - getCurrentValue
```
public java.lang.Object getCurrentValue()
```
    Current value.
    
    Returns:
    
    The current value of the represented parameter
  - getCurrentValueOn
```
public java.lang.Object getCurrentValueOn(java.lang.Object o)
```
    Current value on a different object.
    
    Parameters:
    
    o - Object to use to get the value
    
    Returns:
    
    The current value of the represented parameter on a different objetc
  - setValue
```
public void setValue(java.lang.Object o)
```
    Set value.
    
    Parameters:
    
    o - Value to set. Type must match represented parameter type. Note that setting null is not allowed.
  - getType
```
public ParameterWrapper.ParameterType getType()
```
    Type.
    
    Returns:
    
    Type of the represented parameter
  - toStringRepresentation
```
public java.lang.String toStringRepresentation()
```
    Create String representation of the represented value.
    Note that this method uses Enum.name() instead of its Object.toString() since later can be overridden preventing further safe parse.
    
    Note that ParameterWrapper.ParameterType.OTHER type parameters are currently not supported.
    
    Returns:
    
    String representation which can be parsed using parseParameterValue(java.lang.String)
    
    Throws:
    
    java.lang.UnsupportedOperationException - when represented parameter type is ParameterWrapper.ParameterType.OTHER
  - parseParameterValue
```
public void parseParameterValue(java.lang.String value)
```
    Parse parameter value from a String.
    
    Parameters:
    
    value - String value. Note that null values are not allowed.
    
    Throws:
    
    java.lang.IllegalArgumentException - when parse failed
    
    java.lang.UnsupportedOperationException - when represented parameter type is ParameterWrapper.ParameterType.OTHER
  - getLongValue
```
public long getLongValue()
```
    Value of an long field.
    
    Returns:
    
    The value of the long field.
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - setLongValue
```
public void setLongValue(long i)
```
    Set long value of a long field.
    
    Parameters:
    
    i - Value to be set
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - getIntValue
```
public int getIntValue()
```
    Value of an int field.
    
    Returns:
    
    The value of the int field.
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - setIntValue
```
public void setIntValue(int i)
```
    Set int value of a int field.
    
    Parameters:
    
    i - Value to be set
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - getDoubleValue
```
public double getDoubleValue()
```
    Value of a double field.
    
    Returns:
    
    The value of the represented double field.
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - setDoubleValue
```
public void setDoubleValue(double d)
```
    Set value of a double field.
    
    Parameters:
    
    d - Value to be set
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - getStringValue
```
public java.lang.String getStringValue()
```
    Value of a String field.
    
    Returns:
    
    The value of a String field.
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - setStringValue
```
public void setStringValue(java.lang.String s)
```
    Set String value of a String field.
    
    Parameters:
    
    s - Value to be set
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - getBooleanValue
```
public boolean getBooleanValue()
```
    Value of a boolean field.
    
    Returns:
    
    The value of a boolean field.
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - setBooleanValue
```
public void setBooleanValue(boolean b)
```
    Set value of a boolean field.
    
    Parameters:
    
    b - Value to be set
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different
  - getParameterClass
```
public java.lang.Class<?> getParameterClass()
```
    Parameter field class.
    
    Returns:
    
    Parameter field class
  - getEnumParameterClass
```
public java.lang.Class<? extends java.lang.Enum> getEnumParameterClass()
```
    Return enum class for enum field.
    
    Returns:
    
    Enum class for enum field
  - getEnumValue
```
public java.lang.Enum getEnumValue()
```
    Value of an enum field.
    
    Returns:
    
    The current value
    
    Throws:
    
    java.lang.UnsupportedOperationException - when the associated parameters type is different

Class ParameterWrapper

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAPIFieldName

getShortName

getName

getDetailedDescription

getMinDouble

getMaxDouble

getMinLong

getMaxLong

getCurrentValue

getCurrentValueOn

setValue

getType

toStringRepresentation

parseParameterValue

getLongValue

setLongValue

getIntValue

setIntValue

getDoubleValue

setDoubleValue

getStringValue

setStringValue

getBooleanValue

setBooleanValue

getParameterClass

getEnumParameterClass

getEnumValue