org.eclipse.xtext.resource

Class SaveOptions

java.lang.Object

org.eclipse.xtext.resource.SaveOptions

public class SaveOptions
extends Object

Immutable SaveOptions can be used to read and write options into the map that is passed into 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.

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SaveOptions.Builder Allows to create new SaveOptions in a readable manner.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SaveOptions(boolean formatting, boolean validating)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTo(Map<Object,Object> saveOptions) Configures the save options into the given map.
static SaveOptions	defaultOptions() This is equal to builder().getOptions().
boolean	equals(Object obj)
static SaveOptions	getOptions(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()
Map<Object,Object>	toOptionsMap()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY

protected static final String KEY

Constructor Detail

SaveOptions

protected SaveOptions(boolean formatting,
           boolean validating)

Method Detail

getOptions

public static SaveOptions getOptions(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.

Parameters:

saveOptions - the options-map or null if none.

Returns:

the options to use. Will never return null.

addTo

public void addTo(Map<Object,Object> saveOptions)

Configures the save options into the given map. The method modifies the given parameter so it may not be an ImmutableMap or a read-only Map.

Parameters:

saveOptions - the options to be modified. May not be null.

toOptionsMap

public Map<Object,Object> toOptionsMap()

isFormatting

public boolean isFormatting()

isValidating

public boolean isValidating()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

newBuilder

public static SaveOptions.Builder newBuilder()

defaultOptions

public static SaveOptions defaultOptions()

This is equal to builder().getOptions().