Top Description Inners Fields Constructors Methods
com.ibm.icu.impl.personname

pack-priv abstract Class FieldModifierImpl

extends Object
Class Inheritance
Known Direct Subclasses
com.ibm.icu.impl.personname.FieldModifierImpl.AllCapsModifier, com.ibm.icu.impl.personname.FieldModifierImpl.InitialCapModifier, com.ibm.icu.impl.personname.FieldModifierImpl.InitialModifier
Imports
java.util.Locale, com.ibm.icu.lang.UCharacter, com.ibm.icu.text.BreakIterator, .CaseMap, .PersonName, .SimpleFormatter

Parent class for classes that implement field-modifier behavior.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
FieldModifierImpl.AllCapsModifier

A field modifier that returns the field value converted to ALL CAPS.

private static class
FieldModifierImpl.InitialCapModifier

A field modifier that returns the field value with the first letter of each word capitalized.

pack-priv static class
FieldModifierImpl.InitialModifier

A field modifier that returns the field value converted into one or more initials.

Field Summary

Modifier and TypeField and Description
private static final FieldModifierImpl
MONOGRAM_MODIFIER

A field modifier that simply returns the first grapheme cluster in the field value.

private static final FieldModifierImpl
NOOP_MODIFIER

A field modifier that just returns the field value unmodified.

private static final FieldModifierImpl
NULL_MODIFIER

A field modifier that just returns the empty string.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static FieldModifierImpl
private static String
getFirstGrapheme(String s)

A utility function that just returns the first grapheme cluster in the string.

public abstract String
modifyField(String fieldValue)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

MONOGRAM_MODIFIERback to summary
private static final FieldModifierImpl MONOGRAM_MODIFIER

A field modifier that simply returns the first grapheme cluster in the field value. This is the default implementation of the "monogram" modifier.

NOOP_MODIFIERback to summary
private static final FieldModifierImpl NOOP_MODIFIER

A field modifier that just returns the field value unmodified. This is used to implement the default behavior of the "informal" and "core" modifiers ("real" informal or core variants have to be supplied or calculated by the PersonName object).

NULL_MODIFIERback to summary
private static final FieldModifierImpl NULL_MODIFIER

A field modifier that just returns the empty string. This is used to implement the default behavior of the "prefix" modifier ("real" prefix variants have to be supplied to calculated by the PersonName object).

Constructor Detail

FieldModifierImplback to summary
pack-priv FieldModifierImpl()

Method Detail

forNameback to summary
public static FieldModifierImpl forName(PersonName.FieldModifier modifierID, PersonNameFormatterImpl formatterImpl)
getFirstGraphemeback to summary
private static String getFirstGrapheme(String s)

A utility function that just returns the first grapheme cluster in the string.

modifyFieldback to summary
public abstract String modifyField(String fieldValue)
com.ibm.icu.impl.personname back to summary

private Class FieldModifierImpl.AllCapsModifier

extends FieldModifierImpl
Class Inheritance

A field modifier that returns the field value converted to ALL CAPS. This is the default behavior for the "allCaps" modifier.

Field Summary

Modifier and TypeField and Description
private final Locale

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
Inherited from com.ibm.icu.impl.personname.FieldModifierImpl:
forName

Field Detail

localeback to summary
private final Locale locale

Constructor Detail

AllCapsModifierback to summary
public AllCapsModifier(Locale locale)

Method Detail

modifyFieldback to summary
public String modifyField(String fieldValue)

Implements abstract com.ibm.icu.impl.personname.FieldModifierImpl.modifyField.

Annotations
@Override
com.ibm.icu.impl.personname back to summary

private Class FieldModifierImpl.InitialCapModifier

extends FieldModifierImpl
Class Inheritance

A field modifier that returns the field value with the first letter of each word capitalized. This is the default behavior of the "initialCap" modifier.

Field Summary

Modifier and TypeField and Description
private final Locale
private static final CaseMap.Title

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
Inherited from com.ibm.icu.impl.personname.FieldModifierImpl:
forName

Field Detail

localeback to summary
private final Locale locale
TO_TITLE_WHOLE_STRING_NO_LOWERCASEback to summary
private static final CaseMap.Title TO_TITLE_WHOLE_STRING_NO_LOWERCASE

Constructor Detail

InitialCapModifierback to summary
public InitialCapModifier(Locale locale)

Method Detail

modifyFieldback to summary
public String modifyField(String fieldValue)

Implements abstract com.ibm.icu.impl.personname.FieldModifierImpl.modifyField.

Annotations
@Override
com.ibm.icu.impl.personname back to summary

pack-priv Class FieldModifierImpl.InitialModifier

extends FieldModifierImpl
Class Inheritance

A field modifier that returns the field value converted into one or more initials. This is the first grapheme cluster of each word in the field value, modified using the initialPattern/initial resource value from the locale data, and strung together using the initialPattern/initialSequence resource value from the locale data. (In English, these patterns put periods after each initial and connect them with spaces.) This is default behavior of the "initial" modifier.

Field Summary

Modifier and TypeField and Description
private final SimpleFormatter
private final SimpleFormatter
private final Locale
private boolean

Constructor Summary

AccessConstructor and Description
public
InitialModifier(Locale locale, String initialPattern, String initialSequencePattern)

Method Summary

Modifier and TypeMethod and Description
public String
public void
setRetainPunctuation(boolean retain)

Inherited from com.ibm.icu.impl.personname.FieldModifierImpl:
forName

Field Detail

initialFormatterback to summary
private final SimpleFormatter initialFormatter
initialSequenceFormatterback to summary
private final SimpleFormatter initialSequenceFormatter
localeback to summary
private final Locale locale
retainPunctuationback to summary
private boolean retainPunctuation

Constructor Detail

InitialModifierback to summary
public InitialModifier(Locale locale, String initialPattern, String initialSequencePattern)

Method Detail

modifyFieldback to summary
public String modifyField(String fieldValue)

Implements abstract com.ibm.icu.impl.personname.FieldModifierImpl.modifyField.

Annotations
@Override
setRetainPunctuationback to summary
public void setRetainPunctuation(boolean retain)