Package com.google.common.css

Enum Class OutputRenamingMapFormat

java.lang.Object

java.lang.Enum<OutputRenamingMapFormat>

com.google.common.css.OutputRenamingMapFormat

All Implemented Interfaces:

Serializable, Comparable<OutputRenamingMapFormat>, Constable

public enum OutputRenamingMapFormat
extends Enum<OutputRenamingMapFormat>

Defines the values for the --output-renaming-map-format flag in Closure Stylesheets.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSURE_COMPILED	Reads/Writes the mapping as JSON, passed as an argument to goog.setCssNameMapping().
CLOSURE_COMPILED_BY_WHOLE	Reads/Writes the mapping as JSON, passed as an argument to goog.setCssNameMapping() using the 'BY_WHOLE' mapping style.
CLOSURE_COMPILED_SPLIT_HYPHENS	Before writing the mapping as CLOSURE_COMPILED, split the css name maps by hyphens and write out each piece individually.
CLOSURE_UNCOMPILED	Reads/Writes the mapping as JSON, assigned to the global JavaScript variable CLOSURE_CSS_NAME_MAPPING.
JSCOMP_VARIABLE_MAP	This is the current default behavior for output maps.
JSON	Reads/Writes the mapping as JSON.
PROPERTIES	Reads/Writes the mapping from/in a .properties file format, such that it can be read by Properties.

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableMap<String,String>	readRenamingMap(Reader in)	Reads the output of writeRenamingMap(java.util.Map<java.lang.String, java.lang.String>, java.io.Writer) so a renaming map can be reused from one compile to another.
static OutputRenamingMapFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutputRenamingMapFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
final void	writeRenamingMap(Map<String,String> renamingMap, PrintWriter renamingMapWriter)	Like writeRenamingMap(java.util.Map, java.io.Writer) but does not throw when writes fail.
void	writeRenamingMap(Map<String,String> renamingMap, Writer renamingMapWriter)	Writes the renaming map.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLOSURE_COMPILED

public static final OutputRenamingMapFormat CLOSURE_COMPILED

Reads/Writes the mapping as JSON, passed as an argument to goog.setCssNameMapping(). Designed for use with the Closure Library in compiled mode.

CLOSURE_COMPILED_BY_WHOLE

public static final OutputRenamingMapFormat CLOSURE_COMPILED_BY_WHOLE

Reads/Writes the mapping as JSON, passed as an argument to goog.setCssNameMapping() using the 'BY_WHOLE' mapping style. Designed for use with the Closure Library in compiled mode where the CSS name substitutions are taken as-is, which allows, e.g., using SimpleSubstitutionMap with class names containing hyphens.

CLOSURE_COMPILED_SPLIT_HYPHENS

public static final OutputRenamingMapFormat CLOSURE_COMPILED_SPLIT_HYPHENS

Before writing the mapping as CLOSURE_COMPILED, split the css name maps by hyphens and write out each piece individually. see CLOSURE_COMPILED

CLOSURE_UNCOMPILED

public static final OutputRenamingMapFormat CLOSURE_UNCOMPILED

Reads/Writes the mapping as JSON, assigned to the global JavaScript variable CLOSURE_CSS_NAME_MAPPING. Designed for use with the Closure Library in uncompiled mode.

JSON

public static final OutputRenamingMapFormat JSON

Reads/Writes the mapping as JSON.

PROPERTIES

public static final OutputRenamingMapFormat PROPERTIES

Reads/Writes the mapping from/in a .properties file format, such that it can be read by Properties.

JSCOMP_VARIABLE_MAP

public static final OutputRenamingMapFormat JSCOMP_VARIABLE_MAP

This is the current default behavior for output maps. Still used for legacy reasons.

Method Details

values

public static OutputRenamingMapFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OutputRenamingMapFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

writeRenamingMap

public void writeRenamingMap(Map<String,String> renamingMap,
 Writer renamingMapWriter)
                      throws IOException

Writes the renaming map.

Throws:

IOException

See Also:

• #writeRenamingMap(Map, PrintWriter)

writeRenamingMap

public final void writeRenamingMap(Map<String,String> renamingMap,
 PrintWriter renamingMapWriter)

Like writeRenamingMap(java.util.Map, java.io.Writer) but does not throw when writes fail.

readRenamingMap

public com.google.common.collect.ImmutableMap<String,String> readRenamingMap(Reader in)
                                                                      throws IOException

Reads the output of writeRenamingMap(java.util.Map<java.lang.String, java.lang.String>, java.io.Writer) so a renaming map can be reused from one compile to another.

Throws:

IOException