public class SaveOptions
extends java.lang.Object
Resource.save(Map)
.
Clients should create options by means of SaveOptions.newBuilder()
and
subsequent calls to configure the result or SaveOptions.defaultOptions()
.
The options map may be populated via toOptionsMap()
or addTo(Map)
.
Clients are free to extend this interface and the respective builder implementation.Modifier and Type | Class and Description |
---|---|
static class |
SaveOptions.Builder
Allows to create new
SaveOptions in a readable manner. |
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
KEY |
Modifier | Constructor and Description |
---|---|
protected |
SaveOptions(boolean formatting,
boolean validating) |
Modifier and Type | Method and Description |
---|---|
void |
addTo(java.util.Map<java.lang.Object,java.lang.Object> saveOptions)
Configures the save options into the given map.
|
static SaveOptions |
defaultOptions()
This is equal to
builder().getOptions() . |
boolean |
equals(java.lang.Object obj) |
static SaveOptions |
getOptions(java.util.Map<?,?> saveOptions)
Transparently handles the deprecated options that could be passed as
map-entries to
Resource.save(Map)
and converts them to semantically equal SaveOptions . |
int |
hashCode() |
boolean |
isFormatting() |
boolean |
isValidating() |
static SaveOptions.Builder |
newBuilder() |
java.util.Map<java.lang.Object,java.lang.Object> |
toOptionsMap() |
java.lang.String |
toString() |
public static SaveOptions getOptions(java.util.Map<?,?> saveOptions)
Resource.save(Map)
and converts them to semantically equal SaveOptions
.saveOptions
- the options-map or null
if none.null
.public void addTo(java.util.Map<java.lang.Object,java.lang.Object> saveOptions)
saveOptions
- the options to be modified. May not be null
.public java.util.Map<java.lang.Object,java.lang.Object> toOptionsMap()
public boolean isFormatting()
public boolean isValidating()
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public static SaveOptions.Builder newBuilder()
public static SaveOptions defaultOptions()
builder().getOptions()
.