EE4J 10.0.0 · jakarta.faces.convert.NumberConverter

Converter implementation for java.lang.Number values.

The getAsObject() method parses a String into an java.lang.Double or java.lang.Long, according to the following algorithm:

If the specified String is null, return a null. Otherwise, trim leading and trailing whitespace before proceeding.
If the specified String - after trimming - has a zero length, return null.
If the locale property is not null, use that Locale for managing parsing. Otherwise, use the Locale from the UIViewRoot.
If a pattern has been specified, its syntax must conform the rules specified by java.text.DecimalFormat. Such a pattern will be used to parse, and the type property will be ignored.
If a pattern has not been specified, parsing will be based on the type property, which expects a currency, a number, or a percent. The parse pattern for currencies, numbers, and percentages is determined by calling the getCurrencyInstance(), getNumberInstance(), or getPercentInstance() method of the java.text.NumberFormat class, passing in the selected Locale.
If the integerOnly property has been set to true, only the integer portion of the String will be parsed. See the JavaDocs for the setParseIntegerOnly() method of the java.text.NumberFormat class for more information.

The getAsString() method expects a value of type java.lang.Number (or a subclass), and creates a formatted String according to the following algorithm:

If the specified value is null, return a zero-length String.
If the specified value is a String, return it unmodified.
If the locale property is not null, use that Locale for managing formatting. Otherwise, use the Locale from the FacesContext.
If a pattern has been specified, its syntax must conform the rules specified by java.text.DecimalFormat. Such a pattern will be used to format, and the type property (along with related formatting options described in the next paragraph) will be ignored.
If a pattern has not been specified, formatting will be based on the type property, which formats the value as a currency, a number, or a percent. The format pattern for currencies, numbers, and percentages is determined by calling the percentages is determined by calling the getCurrencyInstance(), getNumberInstance(), or getPercentInstance() method of the java.text.NumberFormat class, passing in the selected Locale. In addition, the following properties will be applied to the format pattern, if specified:
- If the groupingUsed property is true, the setGroupingUsed(true) method on the corresponding NumberFormat instance will be called.
- The minimum and maximum number of digits in the integer and fractional portions of the result will be configured based on any values set for the maxFractionDigits, maxIntegerDigits, minFractionDigits, and minIntegerDigits properties.
- If the type is set to currency, it is also possible to configure the currency symbol to be used, using either the currencyCode or currencySymbol properties. If both are set, the value for currencyCode takes precedence on a JDK 1.4 (or later) JVM; otherwise, the value for currencySymbol takes precedence.

Field Summary

Modifier and Type	Field and Description
public static final String	CONVERTER_ID The standard converter id for this converter.
public static final String	CURRENCY_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails.
private static Class<T>	currencyClass
private String	currencyCode
private String	currencySymbol
private static final Class<T>[]	GET_INSTANCE_PARAM_TYPES
private Boolean	groupingUsed
private boolean	initialState
private Boolean	integerOnly
private Locale	locale
private Integer	maxFractionDigits
private Integer	maxIntegerDigits
private Integer	minFractionDigits
private Integer	minIntegerDigits
private static final String	NBSP
public static final String	NUMBER_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails.
private String	pattern
public static final String	PATTERN_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails.
public static final String	PERCENT_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails.
public static final String	STRING_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion of the `Number` value to `String` fails.
private boolean	transientFlag
private String	type

Constructor Summary

Access	Constructor and Description
public	NumberConverter()

Method Summary

Modifier and Type	Method and Description
public void	clearInitialState() Implements jakarta.faces.component.PartialStateHolder.clearInitialState. Reset the PartialStateHolder to a non-delta tracking state.
private void	configureCurrency(NumberFormat The `NumberFormatter` to be configured formatter) Override the formatting locale's default currency symbol with the specified currency code (specified via the "currencyCode" attribute) or currency symbol (specified via the "currencySymbol" attribute).
private void	configureFormatter(NumberFormat The `NumberFormat` instance to configure formatter) Configure the specified `NumberFormat` based on the formatting properties that have been set.
public Object	getAsObject(FacesContext `FacesContext` for the request being processed context, UIComponent `UIComponent` with which this model object value is associated component, String String value to be converted (may be `null`) value) Implements jakarta.faces.convert.Converter.getAsObject. Convert the specified string value, which is associated with the specified `UIComponent`, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle.
public String	getAsString(FacesContext `FacesContext` for the request being processed context, UIComponent `UIComponent` with which this model object value is associated component, Object Model object value to be converted (may be `null`) value) Implements jakarta.faces.convert.Converter.getAsString. Convert the specified model object value, which is associated with the specified `UIComponent`, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.
public String	Returns: the currency code getCurrencyCode() Return the ISO 4217 currency code used by `getAsString()` with a `type` of `currency`.
public String	Returns: the currency symbol getCurrencySymbol() Return the currency symbol used by `getAsString()` with a `type` of `currency`.
public Locale	Returns: the `Locale` for this converter getLocale() Return the `Locale` to be used when parsing numbers.
private Locale	getLocale(FacesContext The `FacesContext` for the current request context) Return the `Locale` we will use for localizing our formatting and parsing processing.
public int	Returns: the maximum fraction digits getMaxFractionDigits() Return the maximum number of digits `getAsString()` should render in the fraction portion of the result.
public int	Returns: the max integer digits getMaxIntegerDigits() Return the maximum number of digits `getAsString()` should render in the integer portion of the result.
public int	Returns: the min fraction digits getMinFractionDigits() Return the minimum number of digits `getAsString()` should render in the fraction portion of the result.
public int	Returns: the minimum integer digits getMinIntegerDigits() Return the minimum number of digits `getAsString()` should render in the integer portion of the result.
private NumberFormat	getNumberFormat(Locale The `Locale` used to select formatting and parsing conventions locale) Return a `NumberFormat` instance to use for formatting and parsing in this `Converter`.
public String	Returns: the pattern getPattern() Return the format pattern to be used when formatting and parsing numbers.
public String	Returns: the type getType() Return the number type to be used when formatting and parsing numbers.
public boolean	initialStateMarked() Implements jakarta.faces.component.PartialStateHolder.initialStateMarked. Return `true` if delta state changes are being tracked, otherwise `false`
public boolean	Returns: whether or not grouping is used isGroupingUsed() Return `true` if `getAsString` should include grouping separators if necessary.
public boolean	Returns: whether or not this is integer only isIntegerOnly() Return `true` if only the integer portion of the given value should be returned from `getAsObject()`.
private boolean	isMaxFractionDigitsSet()
private boolean	isMaxIntegerDigitsSet()
private boolean	isMinFractionDigitsSet()
private boolean	isMinIntegerDigitsSet()
public boolean	isTransient() Implements jakarta.faces.component.StateHolder.isTransient. If true, the Object implementing this interface must not participate in state saving or restoring.
public void	markInitialState() Implements jakarta.faces.component.PartialStateHolder.markInitialState. The runtime must ensure that the `markInitialState` method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state.
public void	restoreState(FacesContext the Faces context. context, Object the state. state) Implements jakarta.faces.component.StateHolder.restoreState. Perform any processing required to restore the state from the entries in the state Object.
public Object	saveState(FacesContext the Faces context. context) Implements jakarta.faces.component.StateHolder.saveState. Gets the state of the instance as a `Serializable` Object.
public void	setCurrencyCode(String The new currency code currencyCode) Set the ISO 4217 currency code used by `getAsString()` with a `type` of `currency`.
public void	setCurrencySymbol(String The new currency symbol currencySymbol) Set the currency symbol used by `getAsString()` with a `type` of `currency`.
public void	setGroupingUsed(boolean The new grouping used flag groupingUsed) Set the flag indicating whether `getAsString()` should include grouping separators if necessary.
public void	setIntegerOnly(boolean The new integer-only flag integerOnly) Set to `true` if only the integer portion of the given value should be returned from `getAsObject()`.
public void	setLocale(Locale The new `Locale` (or `null`) locale) Set the `Locale` to be used when parsing numbers.
public void	setMaxFractionDigits(int The new limit maxFractionDigits) Set the maximum number of digits `getAsString()` should render in the fraction portion of the result.
public void	setMaxIntegerDigits(int The new limit maxIntegerDigits) Set the maximum number of digits `getAsString()` should render in the integer portion of the result.
public void	setMinFractionDigits(int The new limit minFractionDigits) Set the minimum number of digits `getAsString()` should render in the fraction portion of the result.
public void	setMinIntegerDigits(int The new limit minIntegerDigits) Set the minimum number of digits `getAsString()` should render in the integer portion of the result.
public void	setPattern(String The new format pattern pattern) Set the format pattern to be used when formatting and parsing numbers.
public void	setTransient(boolean boolean pass `true` if this Object will not participate in state saving or restoring, otherwise pass `false`. transientFlag) Implements jakarta.faces.component.StateHolder.setTransient. Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
public void	setType(String The new number style type) Set the number type to be used when formatting and parsing numbers.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CONVERTER_ID	back to summary
public static final String CONVERTER_ID The standard converter id for this converter.

CURRENCY_ID back to summary

CURRENCY_ID	back to summary
public static final String CURRENCY_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails. The message format string for this message may optionally include the following placeholders: `{0}` replaced by the unconverted value. `{1}` replaced by an example value. `{2}` replaced by a `String` whose value is the label of the input component that produced this message.

public static final String CURRENCY_ID

The message identifier of the jakarta.faces.application.FacesMessage to be created if the conversion to Number fails. The message format string for this message may optionally include the following placeholders:

{0} replaced by the unconverted value.
{1} replaced by an example value.
{2} replaced by a String whose value is the label of the input component that produced this message.

currencyClass	back to summary
private static Class<T> currencyClass

currencyCode	back to summary
private String currencyCode

currencySymbol	back to summary
private String currencySymbol

GET_INSTANCE_PARAM_TYPES	back to summary
private static final Class<T>[] GET_INSTANCE_PARAM_TYPES

groupingUsed	back to summary
private Boolean groupingUsed

initialState	back to summary
private boolean initialState

integerOnly	back to summary
private Boolean integerOnly

locale	back to summary
private Locale locale

maxFractionDigits	back to summary
private Integer maxFractionDigits

maxIntegerDigits	back to summary
private Integer maxIntegerDigits

minFractionDigits	back to summary
private Integer minFractionDigits

minIntegerDigits	back to summary
private Integer minIntegerDigits

NBSP	back to summary
private static final String NBSP

NUMBER_ID back to summary

NUMBER_ID	back to summary
public static final String NUMBER_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails. The message format string for this message may optionally include the following placeholders: `{0}` replaced by the unconverted value. `{1}` replaced by an example value. `{2}` replaced by a `String` whose value is the label of the input component that produced this message.

public static final String NUMBER_ID

{0} replaced by the unconverted value.
{1} replaced by an example value.
{2} replaced by a String whose value is the label of the input component that produced this message.

pattern	back to summary
private String pattern

PATTERN_ID back to summary

PATTERN_ID	back to summary
public static final String PATTERN_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails. The message format string for this message may optionally include the following placeholders: `{0}` replaced by the unconverted value. `{1}` replaced by an example value. `{2}` replaced by a `String` whose value is the label of the input component that produced this message.

public static final String PATTERN_ID

{0} replaced by the unconverted value.
{1} replaced by an example value.
{2} replaced by a String whose value is the label of the input component that produced this message.

PERCENT_ID back to summary

PERCENT_ID	back to summary
public static final String PERCENT_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion to `Number` fails. The message format string for this message may optionally include the following placeholders: `{0}` replaced by the unconverted value. `{1}` replaced by an example value. `{2}` replaced by a `String` whose value is the label of the input component that produced this message.

public static final String PERCENT_ID

{0} replaced by the unconverted value.
{1} replaced by an example value.
{2} replaced by a String whose value is the label of the input component that produced this message.

STRING_ID back to summary

STRING_ID	back to summary
public static final String STRING_ID The message identifier of the `jakarta.faces.application.FacesMessage` to be created if the conversion of the `Number` value to `String` fails. The message format string for this message may optionally include the following placeholders: `{0}` relaced by the unconverted value. `{1}` replaced by a `String` whose value is the label of the input component that produced this message.

public static final String STRING_ID

The message identifier of the jakarta.faces.application.FacesMessage to be created if the conversion of the Number value to String fails. The message format string for this message may optionally include the following placeholders:

{0} relaced by the unconverted value.
{1} replaced by a String whose value is the label of the input component that produced this message.

transientFlag	back to summary
private boolean transientFlag

type	back to summary
private String type

Constructor Detail

NumberConverter	back to summary
public NumberConverter()

Method Detail

clearInitialState	back to summary
public void clearInitialState() Implements jakarta.faces.component.PartialStateHolder.clearInitialState. Doc from jakarta.faces.component.PartialStateHolder.clearInitialState. Reset the PartialStateHolder to a non-delta tracking state. Annotations @Override

clearInitialState

back to summary

public void clearInitialState()

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

Doc from jakarta.faces.component.PartialStateHolder.clearInitialState.

Reset the PartialStateHolder to a non-delta tracking state.

Annotations

@Override

configureCurrency back to summary

configureCurrency	back to summary
private void configureCurrency(NumberFormat formatter) throws Exception Override the formatting locale's default currency symbol with the specified currency code (specified via the "currencyCode" attribute) or currency symbol (specified via the "currencySymbol" attribute). If both "currencyCode" and "currencySymbol" are present, "currencyCode" takes precedence over "currencySymbol" if the java.util.Currency class is defined in the container's runtime (that is, if the container's runtime is J2SE 1.4 or greater), and "currencySymbol" takes precendence over "currencyCode" otherwise. If only "currencyCode" is given, it is used as a currency symbol if java.util.Currency is not defined. Example: JDK "currencyCode" "currencySymbol" Currency symbol being displayed ----------------------------------------------------------------------- all --- --- Locale's default currency symbol <1.4 EUR --- EUR >=1.4 EUR --- Locale's currency symbol for Euro all --- € € <1.4 EUR € € >=1.4 EUR € Locale's currency symbol for Euro Parameters formatter:NumberFormat The `NumberFormatter` to be configured

private void configureCurrency(NumberFormat formatter) throws Exception

Override the formatting locale's default currency symbol with the specified currency code (specified via the "currencyCode" attribute) or currency symbol (specified via the "currencySymbol" attribute).

If both "currencyCode" and "currencySymbol" are present, "currencyCode" takes precedence over "currencySymbol" if the java.util.Currency class is defined in the container's runtime (that is, if the container's runtime is J2SE 1.4 or greater), and "currencySymbol" takes precendence over "currencyCode" otherwise.

If only "currencyCode" is given, it is used as a currency symbol if java.util.Currency is not defined.

Example:

JDK    "currencyCode" "currencySymbol" Currency symbol being displayed
-----------------------------------------------------------------------
all         ---            ---         Locale's default currency symbol

<1.4        EUR            ---         EUR
>=1.4       EUR            ---         Locale's currency symbol for Euro

all         ---           €       €

<1.4        EUR           €       €
>=1.4       EUR           €       Locale's currency symbol for Euro

Parameters

formatter:NumberFormat: The NumberFormatter to be configured

configureFormatter back to summary

configureFormatter	back to summary
private void configureFormatter(NumberFormat formatter) Configure the specified `NumberFormat` based on the formatting properties that have been set. Parameters formatter:NumberFormat The `NumberFormat` instance to configure

private void configureFormatter(NumberFormat formatter)

Configure the specified NumberFormat based on the formatting properties that have been set.

Parameters

formatter:NumberFormat: The NumberFormat instance to configure

getAsObject back to summary

getAsObject	back to summary
public Object getAsObject(FacesContext context, UIComponent component, String value) Implements jakarta.faces.convert.Converter.getAsObject. Doc from jakarta.faces.convert.Converter.getAsObject. Convert the specified string value, which is associated with the specified `UIComponent`, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. Parameters context:FacesContext `FacesContext` for the request being processed component:UIComponent `UIComponent` with which this model object value is associated value:String String value to be converted (may be `null`) Returns:Object `null` if the value to convert is `null`, otherwise the result of the conversion Annotations @Override Exceptions ConverterException: if conversion cannot be successfully performed NullPointerException: if `context` or `component` is `null`

public Object getAsObject(FacesContext context, UIComponent component, String value)

Implements jakarta.faces.convert.Converter.getAsObject.

Doc from jakarta.faces.convert.Converter.getAsObject.

Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle.

Parameters

context:FacesContext: FacesContext for the request being processed
component:UIComponent: UIComponent with which this model object value is associated
value:String: String value to be converted (may be null)

Returns:Object

null if the value to convert is null, otherwise the result of the conversion

Annotations

@Override

Exceptions

ConverterException:: if conversion cannot be successfully performed
NullPointerException:: if context or component is null

getAsString back to summary

getAsString	back to summary
public String getAsString(FacesContext context, UIComponent component, Object value) Implements jakarta.faces.convert.Converter.getAsString. Doc from jakarta.faces.convert.Converter.getAsString. Convert the specified model object value, which is associated with the specified `UIComponent`, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle. Parameters context:FacesContext `FacesContext` for the request being processed component:UIComponent `UIComponent` with which this model object value is associated value:Object Model object value to be converted (may be `null`) Returns:String a zero-length String if value is `null`, otherwise the result of the conversion Annotations @Override Exceptions ConverterException: if conversion cannot be successfully performed NullPointerException: if `context` or `component` is `null`

public String getAsString(FacesContext context, UIComponent component, Object value)

Implements jakarta.faces.convert.Converter.getAsString.

Doc from jakarta.faces.convert.Converter.getAsString.

Convert the specified model object value, which is associated with the specified UIComponent, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.

Parameters

context:FacesContext: FacesContext for the request being processed
component:UIComponent: UIComponent with which this model object value is associated
value:Object: Model object value to be converted (may be null)

Returns:String

a zero-length String if value is null, otherwise the result of the conversion

Annotations

@Override

Exceptions

ConverterException:: if conversion cannot be successfully performed
NullPointerException:: if context or component is null

getCurrencyCode back to summary

getCurrencyCode	back to summary
public String getCurrencyCode() Return the ISO 4217 currency code used by `getAsString()` with a `type` of `currency`. If not set, the value used will be based on the formatting `Locale`. Returns:String the currency code

public String getCurrencyCode()

Return the ISO 4217 currency code used by getAsString() with a type of currency. If not set, the value used will be based on the formatting Locale.

Returns:String: the currency code

getCurrencySymbol back to summary

getCurrencySymbol	back to summary
public String getCurrencySymbol() Return the currency symbol used by `getAsString()` with a `type` of `currency`. If not set, the value used will be based on the formatting `Locale`. Returns:String the currency symbol

public String getCurrencySymbol()

Return the currency symbol used by getAsString() with a type of currency. If not set, the value used will be based on the formatting Locale.

Returns:String: the currency symbol

getLocale back to summary

getLocale	back to summary
public Locale getLocale() Return the `Locale` to be used when parsing numbers. If this value is `null`, the `Locale` stored in the `jakarta.faces.component.UIViewRoot` for the current request will be utilized. Returns:Locale the `Locale` for this converter

public Locale getLocale()

Return the Locale to be used when parsing numbers. If this value is null, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request will be utilized.

Returns:Locale: the Locale for this converter

getLocale back to summary

getLocale	back to summary
private Locale getLocale(FacesContext context) Return the `Locale` we will use for localizing our formatting and parsing processing. Parameters context:FacesContext The `FacesContext` for the current request

private Locale getLocale(FacesContext context)

Return the Locale we will use for localizing our formatting and parsing processing.

Parameters

context:FacesContext: The FacesContext for the current request

getMaxFractionDigits back to summary

getMaxFractionDigits	back to summary
public int getMaxFractionDigits() Return the maximum number of digits `getAsString()` should render in the fraction portion of the result. Returns:int the maximum fraction digits

public int getMaxFractionDigits()

Return the maximum number of digits getAsString() should render in the fraction portion of the result.

Returns:int: the maximum fraction digits

getMaxIntegerDigits back to summary

getMaxIntegerDigits	back to summary
public int getMaxIntegerDigits() Return the maximum number of digits `getAsString()` should render in the integer portion of the result. Returns:int the max integer digits

public int getMaxIntegerDigits()

Return the maximum number of digits getAsString() should render in the integer portion of the result.

Returns:int: the max integer digits

getMinFractionDigits back to summary

getMinFractionDigits	back to summary
public int getMinFractionDigits() Return the minimum number of digits `getAsString()` should render in the fraction portion of the result. Returns:int the min fraction digits

public int getMinFractionDigits()

Return the minimum number of digits getAsString() should render in the fraction portion of the result.

Returns:int: the min fraction digits

getMinIntegerDigits back to summary

getMinIntegerDigits	back to summary
public int getMinIntegerDigits() Return the minimum number of digits `getAsString()` should render in the integer portion of the result. Returns:int the minimum integer digits

public int getMinIntegerDigits()

Return the minimum number of digits getAsString() should render in the integer portion of the result.

Returns:int: the minimum integer digits

getNumberFormat back to summary

getNumberFormat	back to summary
private NumberFormat getNumberFormat(Locale locale) Return a `NumberFormat` instance to use for formatting and parsing in this `Converter`. Parameters locale:Locale The `Locale` used to select formatting and parsing conventions Exceptions ConverterException: if no instance can be created

private NumberFormat getNumberFormat(Locale locale)

Return a NumberFormat instance to use for formatting and parsing in this Converter.

Parameters

locale:Locale: The Locale used to select formatting and parsing conventions

Exceptions

ConverterException:: if no instance can be created

getPattern	back to summary
public String getPattern() Return the format pattern to be used when formatting and parsing numbers. Returns:String the pattern

getPattern

back to summary

public String getPattern()

Return the format pattern to be used when formatting and parsing numbers.

Returns:String: the pattern

getType back to summary

getType	back to summary
public String getType() Return the number type to be used when formatting and parsing numbers. If not modified, the default type is `number`. Returns:String the type

public String getType()

Return the number type to be used when formatting and parsing numbers. If not modified, the default type is number.

Returns:String: the type

initialStateMarked back to summary

initialStateMarked	back to summary
public boolean initialStateMarked() Implements jakarta.faces.component.PartialStateHolder.initialStateMarked. Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked. Return `true` if delta state changes are being tracked, otherwise `false` Returns:boolean `true` if the initial state is marked, `false` otherwise. Annotations @Override

public boolean initialStateMarked()

Implements jakarta.faces.component.PartialStateHolder.initialStateMarked.

Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked.

Return true if delta state changes are being tracked, otherwise false

Returns:boolean

true if the initial state is marked, false otherwise.

Annotations

@Override

isGroupingUsed back to summary

isGroupingUsed	back to summary
public boolean isGroupingUsed() Return `true` if `getAsString` should include grouping separators if necessary. If not modified, the default value is `true`. Returns:boolean whether or not grouping is used

public boolean isGroupingUsed()

Return true if getAsString should include grouping separators if necessary. If not modified, the default value is true.

Returns:boolean: whether or not grouping is used

isIntegerOnly back to summary

isIntegerOnly	back to summary
public boolean isIntegerOnly() Return `true` if only the integer portion of the given value should be returned from `getAsObject()`. If not modified, the default value is `false`. Returns:boolean whether or not this is integer only

public boolean isIntegerOnly()

Return true if only the integer portion of the given value should be returned from getAsObject(). If not modified, the default value is false.

Returns:boolean: whether or not this is integer only

isMaxFractionDigitsSet	back to summary
private boolean isMaxFractionDigitsSet()

isMaxIntegerDigitsSet	back to summary
private boolean isMaxIntegerDigitsSet()

isMinFractionDigitsSet	back to summary
private boolean isMinFractionDigitsSet()

isMinIntegerDigitsSet	back to summary
private boolean isMinIntegerDigitsSet()

isTransient back to summary

isTransient	back to summary
public boolean isTransient() Implements jakarta.faces.component.StateHolder.isTransient. Doc from jakarta.faces.component.StateHolder.isTransient. If true, the Object implementing this interface must not participate in state saving or restoring. Returns:boolean `true` if transient, `false` otherwise. Annotations @Override

public boolean isTransient()

Implements jakarta.faces.component.StateHolder.isTransient.

Doc from jakarta.faces.component.StateHolder.isTransient.

If true, the Object implementing this interface must not participate in state saving or restoring.

Returns:boolean

true if transient, false otherwise.

Annotations

@Override

markInitialState back to summary

public void markInitialState()

Implements jakarta.faces.component.PartialStateHolder.markInitialState.

Doc from jakarta.faces.component.PartialStateHolder.markInitialState.

The runtime must ensure that the markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that initialStateMarked returns true from the time markInitialState() is called until clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState.

Annotations

@Override

restoreState back to summary

public void restoreState(FacesContext context, Object state)

Implements jakarta.faces.component.StateHolder.restoreState.

Doc from jakarta.faces.component.StateHolder.restoreState.

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the restoreState method on all those instances as well.

If the state argument is null, take no action and return.

Parameters

context:FacesContext: the Faces context.
state:Object: the state.

Annotations

@Override

saveState back to summary

public Object saveState(FacesContext context)

Implements jakarta.faces.component.StateHolder.saveState.

Doc from jakarta.faces.component.StateHolder.saveState.

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the saveState method on all those instances as well. This method must not save the state of children and facets. That is done via the jakarta.faces.application.StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:


Object state = component.saveState(facesContext);

component should be the same as before executing it.

The return from this method must be Serializable

Parameters

context:FacesContext: the Faces context.

Returns:Object

the saved state.

Annotations

@Override

setCurrencyCode back to summary

public void setCurrencyCode(String currencyCode)

Set the ISO 4217 currency code used by getAsString() with a type of currency.

Parameters

currencyCode:String: The new currency code

setCurrencySymbol back to summary

public void setCurrencySymbol(String currencySymbol)

Set the currency symbol used by getAsString() with a type of currency.

Parameters

currencySymbol:String: The new currency symbol

setGroupingUsed back to summary

public void setGroupingUsed(boolean groupingUsed)

Set the flag indicating whether getAsString() should include grouping separators if necessary.

Parameters

groupingUsed:boolean: The new grouping used flag

setIntegerOnly back to summary

public void setIntegerOnly(boolean integerOnly)

Set to true if only the integer portion of the given value should be returned from getAsObject().

Parameters

integerOnly:boolean: The new integer-only flag

setLocale back to summary

public void setLocale(Locale locale)

Set the Locale to be used when parsing numbers. If set to null, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request will be utilized.

Parameters

locale:Locale: The new Locale (or null)

setMaxFractionDigits back to summary

public void setMaxFractionDigits(int maxFractionDigits)

Set the maximum number of digits getAsString() should render in the fraction portion of the result. If not set, the number of digits depends on the value being converted.

Parameters

maxFractionDigits:int: The new limit

setMaxIntegerDigits back to summary

public void setMaxIntegerDigits(int maxIntegerDigits)

Set the maximum number of digits getAsString() should render in the integer portion of the result. If not set, the number of digits depends on the value being converted.

Parameters

maxIntegerDigits:int: The new limit

setMinFractionDigits back to summary

public void setMinFractionDigits(int minFractionDigits)

Set the minimum number of digits getAsString() should render in the fraction portion of the result. If not set, the number of digits depends on the value being converted.

Parameters

minFractionDigits:int: The new limit

setMinIntegerDigits back to summary

public void setMinIntegerDigits(int minIntegerDigits)

Set the minimum number of digits getAsString() should render in the integer portion of the result. If not set, the number of digits depends on the value being converted.

Parameters

minIntegerDigits:int: The new limit

setPattern back to summary

public void setPattern(String pattern)

Set the format pattern to be used when formatting and parsing numbers. Valid values are those supported by java.text.DecimalFormat. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called.

Parameters

pattern:String: The new format pattern

setTransient back to summary

public void setTransient(boolean transientFlag)

Implements jakarta.faces.component.StateHolder.setTransient.

Doc from jakarta.faces.component.StateHolder.setTransient.

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Parameters

transientFlag:boolean: boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

Annotations

@Override

setType back to summary

public void setType(String type)

Set the number type to be used when formatting and parsing numbers. Valid values are currency, number, or percent. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called.

Parameters

type:String: The new number style

public Class NumberConverter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail