public interface Option
Modifier and Type | Method and Description |
---|---|
void |
checkValue(Object value)
Checks that the given value can be coerced into the type given by
getType() . |
boolean |
escapesValue()
Whether this option should escape single quotes in its value.
|
String |
getName()
The (usually lower-cased, underscore-separated) name of this table option.
|
Class<?> |
getType()
The type that values must be able to be coerced into for this option.
|
boolean |
isCoerceable(Object value)
Tests whether the given value can be coerced into the type given by
getType() . |
boolean |
quotesValue()
Whether this option's value should be single-quoted.
|
boolean |
requiresValue()
Whether this option requires a value.
|
boolean |
takesValue()
Whether this option takes a value.
|
String |
toString(Object value)
First ensures that the given value is coerceable into the type expected by this option, then returns the result of
Object.toString() called on the given value. |
Class<?> getType()
String getName()
boolean takesValue()
boolean escapesValue()
boolean quotesValue()
boolean requiresValue()
void checkValue(Object value)
getType()
.boolean isCoerceable(Object value)
getType()
.String toString(@Nullable Object value)
Object.toString()
called on the given value. If this option is escaping quotes (escapesValue()
is
true
), then single quotes will be escaped, and if this option is quoting values ( quotesValue()
is
true
), then the value will be surrounded by single quotes. Given null, returns an empty string.escapesValue()
,
quotesValue()
Copyright © 2011–2018 Pivotal Software, Inc.. All rights reserved.