Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	CaseFormat.StringConverter

Field Summary

Modifier and Type	Field and Description
public static final CaseFormat	LOWER_CAMEL Java variable naming convention, e.g., "lowerCamel".
public static final CaseFormat	LOWER_HYPHEN Hyphenated variable naming convention, e.g., "lower-hyphen".
public static final CaseFormat	LOWER_UNDERSCORE C++ variable naming convention, e.g., "lower_underscore".
public static final CaseFormat	UPPER_CAMEL Java and C++ class naming convention, e.g., "UpperCamel".
public static final CaseFormat	UPPER_UNDERSCORE Java and C++ constant naming convention, e.g., "UPPER_UNDERSCORE".
private final CharMatcher	wordBoundary
private final String	wordSeparator

Constructor Summary

Access	Constructor and Description
private	CaseFormat(CharMatcher wordBoundary, String wordSeparator)

Method Summary

Modifier and Type	Method and Description
pack-priv String	convert(CaseFormat format, String s) Enum values can override for performance reasons.
public Converter<String, String>	converterTo(CaseFormat targetFormat) Returns a serializable `Converter` that converts strings from this format to `targetFormat`.
private static String	firstCharOnlyToUpper(String word)
pack-priv String	normalizeFirstWord(String word)
pack-priv abstract String	normalizeWord(String word)
public final String	to(CaseFormat format, String str) Converts the specified `String str` from this format to the specified `format`.
public static CaseFormat	valueOf(String name)
public static CaseFormat[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LOWER_CAMEL	back to summary
public static final CaseFormat LOWER_CAMEL Java variable naming convention, e.g., "lowerCamel".

LOWER_HYPHEN	back to summary
public static final CaseFormat LOWER_HYPHEN Hyphenated variable naming convention, e.g., "lower-hyphen".

LOWER_UNDERSCORE	back to summary
public static final CaseFormat LOWER_UNDERSCORE C++ variable naming convention, e.g., "lower_underscore".

UPPER_CAMEL	back to summary
public static final CaseFormat UPPER_CAMEL Java and C++ class naming convention, e.g., "UpperCamel".

UPPER_UNDERSCORE	back to summary
public static final CaseFormat UPPER_UNDERSCORE Java and C++ constant naming convention, e.g., "UPPER_UNDERSCORE".

wordBoundary	back to summary
private final CharMatcher wordBoundary

wordSeparator	back to summary
private final String wordSeparator

Constructor Detail

CaseFormat	back to summary
private CaseFormat(CharMatcher wordBoundary, String wordSeparator)

Method Detail

convert	back to summary
pack-priv String convert(CaseFormat format, String s) Enum values can override for performance reasons.

converterTo back to summary

converterTo	back to summary
public Converter<String, String> converterTo(CaseFormat targetFormat) Returns a serializable `Converter` that converts strings from this format to `targetFormat`. Since 16.0

public Converter<String, String> converterTo(CaseFormat targetFormat)

Returns a serializable Converter that converts strings from this format to targetFormat.

Since: 16.0

firstCharOnlyToUpper	back to summary
private static String firstCharOnlyToUpper(String word)

normalizeFirstWord	back to summary
pack-priv String normalizeFirstWord(String word)

normalizeWord	back to summary
pack-priv abstract String normalizeWord(String word)

to	back to summary
public final String to(CaseFormat format, String str) Converts the specified `String str` from this format to the specified `format`. A "best effort" approach is taken; if `str` does not conform to the assumed format, then the behavior of this method is undefined but we make a reasonable effort at converting anyway.

valueOf	back to summary
public static CaseFormat valueOf(String name)

values	back to summary
public static CaseFormat[] values()

com.google.common.base back to summary

private final Class CaseFormat.StringConverter

Class Inheritance

extends Converter<String, String>
implements Serializable

java.lang.Object
com.google.common.base.Converter
com.google.common.base.CaseFormat.StringConverter

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID
private final CaseFormat	sourceFormat
private final CaseFormat	targetFormat

Constructor Summary

Access	Constructor and Description
pack-priv	StringConverter(CaseFormat sourceFormat, CaseFormat targetFormat)

Method Summary

Modifier and Type	Method and Description
protected String	doBackward(String the instance to convert; will never be null s) Implements abstract com.google.common.base.Converter.doBackward. Returns a representation of `b` as an instance of type `A`.
protected String	doForward(String the instance to convert; will never be null s) Implements abstract com.google.common.base.Converter.doForward. Returns a representation of `a` as an instance of type `B`.
public boolean	equals(Object the reference object with which to compare. object) Overrides com.google.common.base.Converter.equals. Implements com.google.common.base.Function.equals. Indicates whether another object is equal to this converter.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.google.common.base.Converter:: andThen apply convert convertAll correctedDoBackward correctedDoForward doAndThen from identity reverse

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

sourceFormat	back to summary
private final CaseFormat sourceFormat

targetFormat	back to summary
private final CaseFormat targetFormat

Constructor Detail

StringConverter	back to summary
pack-priv StringConverter(CaseFormat sourceFormat, CaseFormat targetFormat)

Method Detail

doBackward back to summary

doBackward	back to summary
protected String doBackward(String s) Implements abstract com.google.common.base.Converter.doBackward. Doc from com.google.common.base.Converter.doBackward. Returns a representation of `b` as an instance of type `A`. If `b` cannot be converted, an unchecked exception (such as `IllegalArgumentException`) should be thrown. Parameters s:String the instance to convert; will never be null Returns:String the converted instance; must not be null Annotations @Override

protected String doBackward(String s)

Implements abstract com.google.common.base.Converter.doBackward.

Doc from com.google.common.base.Converter.doBackward.

Returns a representation of b as an instance of type A. If b cannot be converted, an unchecked exception (such as IllegalArgumentException) should be thrown.

Parameters

s:String: the instance to convert; will never be null

Returns:String

the converted instance; must not be null

Annotations

@Override

doForward back to summary

doForward	back to summary
protected String doForward(String s) Implements abstract com.google.common.base.Converter.doForward. Doc from com.google.common.base.Converter.doForward. Returns a representation of `a` as an instance of type `B`. If `a` cannot be converted, an unchecked exception (such as `IllegalArgumentException`) should be thrown. Parameters s:String the instance to convert; will never be null Returns:String the converted instance; must not be null Annotations @Override

protected String doForward(String s)

Implements abstract com.google.common.base.Converter.doForward.

Doc from com.google.common.base.Converter.doForward.

Returns a representation of a as an instance of type B. If a cannot be converted, an unchecked exception (such as IllegalArgumentException) should be thrown.

Parameters

s:String: the instance to convert; will never be null

Returns:String

the converted instance; must not be null

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides com.google.common.base.Converter.equals. Implements com.google.common.base.Function.equals. Doc from com.google.common.base.Converter.equals. Indicates whether another object is equal to this converter. Most implementations will have no reason to override the behavior of `Object#equals`. However, an implementation may also choose to return `true` whenever `object` is a `Converter` that it considers interchangeable with this one. "Interchangeable" typically means that `Objects.equal(this.convert(a), that.convert(a))` is true for all `a` of type `A` (and similarly for `reverse`). Note that a `false` result from this method does not imply that the converters are known not to be interchangeable. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides com.google.common.base.Converter.equals.

Implements com.google.common.base.Function.equals.

Doc from com.google.common.base.Converter.equals.

Indicates whether another object is equal to this converter.

Most implementations will have no reason to override the behavior of Object#equals. However, an implementation may also choose to return true whenever object is a Converter that it considers interchangeable with this one. "Interchangeable" typically means that Objects.equal(this.convert(a), that.convert(a)) is true for all a of type A (and similarly for reverse). Note that a false result from this method does not imply that the converters are known not to be interchangeable.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public sealed Enum CaseFormat

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CaseFormat.StringConverter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail