oracle.javatools.parser.java.v2.write
Class SourcePreferences

java.lang.Object
  oracle.javatools.parser.java.v2.write.SourcePreferences

All Implemented Interfaces:

JavaPreferences

public final class SourcePreferences
extends java.lang.Object
implements JavaPreferences

Storage for the various preference bits defined in JavaPreferences.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.javatools.parser.java.v2.JavaPreferences

JavaPreferences.MemberOrder

Field Summary

Fields inherited from interface oracle.javatools.parser.java.v2.JavaPreferences

BLANKLINES_AFTER_LAST_MEMBER, BLANKLINES_BEFORE_DOC_COMMENT, BLANKLINES_BEFORE_FIELD, BLANKLINES_BEFORE_FIRST_CLASS, BLANKLINES_BEFORE_FIRST_MEMBER, BLANKLINES_BEFORE_MEMBER_CLASS, BLANKLINES_BEFORE_METHOD, BLANKLINES_EMPTY_ANONYMOUS, BLANKLINES_EMPTY_BLOCK, BLANKLINES_EMPTY_CLASS, BLANKLINES_EMPTY_METHOD, BLANKLINES_IMPORTS_AFTER, BLANKLINES_PACKAGE_AFTER, BLANKLINES_PRESERVE_COUNT, CLONE_QUALIFIES_TYPES, FALSE, IGNORED_I, IGNORED_Z, IMPORT_GROUP_IMPORTS, IMPORT_GROUP_PACKAGE_DEPTH, IMPORT_INNER_CLASS_NAME, IMPORT_NARROW_MEMBERS_THRESHOLD, IMPORT_NARROW_THRESHOLD, INDENT_BLOCK_CHILDREN, INDENT_CLASS_MEMBERS, INDENT_CONTROL_BLOCKS, INDENT_NUM_SPACES, INDENT_REPLACE_WITH_TABS, INDENT_SWITCH_CASES, INDENT_TAB_SIZE, INTEGER_ALWAYS_WRAP, INTEGER_NEVER_WRAP, INTEGER_WRAP_IF_LONG, MEMBER_ORDER, NEWLINE_AFTER_SWITCH_CASE, NEWLINE_ARRAY_BRACES, NEWLINE_BLOCK_BRACES, NEWLINE_CATCH, NEWLINE_CLASS_BRACES, NEWLINE_ELSE, NEWLINE_EXTENDS, NEWLINE_FINALLY, NEWLINE_IMPLEMENTS, NEWLINE_METHOD_BRACES, NEWLINE_THROWS, NEWLINE_WHILE, ONE, PREFERENCES_base, PREFERENCES_defaults, PREFERENCES_keys, PREFERENCES_max, PREFERENCES_sun, SPACE_ARGUMENTS_BEFORE, SPACE_ASSIGN_AROUND, SPACE_BINARYOP_AROUND, SPACE_BRACES_AROUND, SPACE_BRACKETS_WITHIN, SPACE_COLON_AFTER, SPACE_COLON_BEFORE, SPACE_COMMA_AFTER, SPACE_COMMA_BEFORE, SPACE_KEYWORD_AFTER, SPACE_OPENBRACE_BEFORE, SPACE_PARAMETERS_BEFORE, SPACE_PARENS_WITHIN, SPACE_QUESTION_AFTER, SPACE_QUESTION_BEFORE, SPACE_SEMICOLON_AFTER, SPACE_SEMICOLON_BEFORE, SPACE_TYPECAST_AFTER, TRI_ALWAYS_WRAP, TRI_NEVER_WRAP, TRI_WRAP_IF_LONG, TRUE, TWO, UNKNOWN_I, UNKNOWN_Z, WRAP_ALIGN, WRAP_ARRAY_CONSTANT, WRAP_BINARY_OPERATOR, WRAP_DOT_CHAIN, WRAP_EXTENDS, WRAP_FOR_STATEMENT, WRAP_INVOKE_ARGUMENTS, WRAP_LINE_WIDTH, WRAP_MODIFIERS, WRAP_PARAMETER_LIST, WRAP_QUES_OPERATOR, WRAP_THROWS, ZERO

Constructor Summary

SourcePreferences()

SourcePreferences(HashStructure hash)

Method Summary

static SourcePreferences	copy(SourcePreferences preferences) Returns a deep copy of the input preferences.
static SourcePreferences	createCascadingPreferences(SourcePreferences preferences) Creates a Preferences object with cascading behavior.
boolean	getBoolean(int setting)
int	getInt(int setting)
java.util.Comparator	getMemberComparator() Creates a comparator based on the current snapshot of the preferences.
byte	getMemberOrder(int member)
HashStructure	getMemberOrderHashStructure() Gets the MEMBER_ORDER hash structure.
java.lang.String	getString(int setting)
void	reloadAll(java.lang.Object[] allPreferences) Overwrites all preferences to become the given parameters.
void	setBoolean(int setting, boolean value)
void	setInt(int setting, int value)
void	setMemberOrder(int member, byte value)
void	setString(int setting, java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourcePreferences

public SourcePreferences()

SourcePreferences

public SourcePreferences(HashStructure hash)

Method Detail

copy

public static SourcePreferences copy(SourcePreferences preferences)

Returns a deep copy of the input preferences.

createCascadingPreferences

public static SourcePreferences createCascadingPreferences(SourcePreferences preferences)

Creates a Preferences object with cascading behavior. This new Preferences object may define (or not define) values. Here, the original Preferences object will be called the "imported" Preferences object. When fetching a value, if it is not set in this object, this will fetch from the imported Preferences.

Changes made to this Preferences object will not affect the imported Preferences object.

We borrow the term "cascading" from CSS.

getBoolean

public boolean getBoolean(int setting)

Parameters:

setting - Valid values are JavaPreferences.*

setBoolean

public void setBoolean(int setting,
                       boolean value)

Parameters:

setting - Valid values are JavaPreferences.*

getString

public java.lang.String getString(int setting)

Parameters:

setting - Valid values are JavaPreferences.*

setString

public void setString(int setting,
                      java.lang.String value)

Parameters:

setting - Valid values are JavaPreferences.*

getInt

public int getInt(int setting)

Parameters:

setting - Valid values are JavaPreferences.*

setInt

public void setInt(int setting,
                   int value)

Parameters:

setting - Valid values are JavaPreferences.*

getMemberOrderHashStructure

public HashStructure getMemberOrderHashStructure()

Gets the MEMBER_ORDER hash structure.

getMemberComparator

public java.util.Comparator getMemberComparator()

Creates a comparator based on the current snapshot of the preferences.

getMemberOrder

public byte getMemberOrder(int member)

Parameters:

member - Valid values are JavaPreferences.MemberOrder.*

setMemberOrder

public void setMemberOrder(int member,
                           byte value)

Parameters:

member - Valid values are JavaPreferences.MemberOrder.*

value - For valid values, refer to MemberOrder.

reloadAll

public void reloadAll(java.lang.Object[] allPreferences)

Overwrites all preferences to become the given parameters.

Parameters:

allPreferences - For an example, see JavaPreferences.PREFERENCES_default.