Modifier and Type	Class and Description
private static enum	ConstrainedFieldPosition.ConstraintType Represents the type of constraint for ConstrainedFieldPosition.

Modifier and Type	Field and Description
private Class<?>	fClassConstraint
private ConstrainedFieldPosition.ConstraintType	fConstraint
private long	fContext
private Format.Field	fField
private int	fLimit
private int	fStart
private Object	fValue

Access	Constructor and Description
public	ConstrainedFieldPosition() Initializes a CategoryFieldPosition.

Method Summary

Modifier and Type	Method and Description
public void	constrainClass(Class<?> The field class to fix when iterating. classConstraint) Sets a constraint on the field class.
public void	constrainField(Format.Field The field to fix when iterating. field) Sets a constraint on the field.
public void	constrainFieldAndValue(Format.Field The field to fix when iterating. field, Object The field value to fix when iterating. fieldValue) Deprecated This API is for technology preview and might be changed or removed in a future release. Sets a constraint on field and field value.
public Format.Field	Returns: The field saved in the instance. See above for null conditions. getField() Gets the field for the current position.
public Object	Returns: The value for the current position. Might be null. getFieldValue() Gets the value associated with the current field position.
public long	Returns: The current iteration context from `setInt64IterationContext`. getInt64IterationContext() Gets an int64 that FormattedValue implementations may use for storage.
public int	Returns: The end index saved in the instance. getLimit() Gets the EXCLUSIVE end index stored for the current position.
public int	Returns: The start index saved in the instance. getStart() Gets the INCLUSIVE start index for the current position.
public boolean	Returns: Whether the field should be included given the constraints. matchesField(Format.Field The field to test. field, Object The field value to test. Should be null if there is no value. fieldValue) Determines whether a given field and value should be included given the constraints.
public void	reset() Resets this ConstrainedFieldPosition to its initial state, as if it were newly created: - Removes any constraints that may have been set on the instance.
public void	setInt64IterationContext(long The new iteration context. context) Sets an int64 that FormattedValue implementations may use for storage.
public void	setState(Format.Field The new field. field, Object The new field value. Should be null if there is no value. value, int The new inclusive start index. start, int The new exclusive end index. limit) Sets new values for the primary public getters.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

fClassConstraint	back to summary
private Class<?> fClassConstraint

fConstraint	back to summary
private ConstrainedFieldPosition.ConstraintType fConstraint

fContext	back to summary
private long fContext

fField	back to summary
private Format.Field fField

fLimit	back to summary
private int fLimit

fStart	back to summary
private int fStart

fValue	back to summary
private Object fValue

Constructor Detail

ConstrainedFieldPosition	back to summary
public ConstrainedFieldPosition() Initializes a CategoryFieldPosition. By default, the CategoryFieldPosition has no iteration constraints. ICU Status Stable since ICU 64.

ConstrainedFieldPosition

back to summary

public ConstrainedFieldPosition()

Initializes a CategoryFieldPosition. By default, the CategoryFieldPosition has no iteration constraints.

ICU Status: Stable since ICU 64.

Method Detail

constrainClass back to summary

constrainClass	back to summary
public void constrainClass(Class<?> classConstraint) Sets a constraint on the field class. When this instance of ConstrainedFieldPosition is passed to `FormattedValue#nextPosition`, positions are skipped unless the field is an instance of the class constraint, including subclasses. Any previously set constraints are cleared. For example, to loop over only the number-related fields: ConstrainedFieldPosition cfpos; cfpos.constrainClass(NumberFormat.Field.class); while (fmtval.nextPosition(cfpos)) { // handle the number-related field position } Parameters classConstraint:Class<?> The field class to fix when iterating. ICU Status Stable since ICU 64.

public void constrainClass(Class<?> classConstraint)

Sets a constraint on the field class. When this instance of ConstrainedFieldPosition is passed to FormattedValue#nextPosition, positions are skipped unless the field is an instance of the class constraint, including subclasses. Any previously set constraints are cleared. For example, to loop over only the number-related fields:

ConstrainedFieldPosition cfpos;
cfpos.constrainClass(NumberFormat.Field.class);
while (fmtval.nextPosition(cfpos)) {
  // handle the number-related field position
}

Parameters

classConstraint:Class<?>: The field class to fix when iterating.

ICU Status

Stable since ICU 64.

constrainField back to summary

constrainField	back to summary
public void constrainField(Format.Field field) Sets a constraint on the field. When this instance of ConstrainedFieldPosition is passed to `FormattedValue#nextPosition`, positions are skipped unless they have the given field. Any previously set constraints are cleared. For example, to loop over all grouping separators: ConstrainedFieldPosition cfpos; cfpos.constrainField(NumberFormat.Field.GROUPING_SEPARATOR); while (fmtval.nextPosition(cfpos)) { // handle the grouping separator position } Changing the constraint while in the middle of iterating over a FormattedValue does not generally have well-defined behavior. Parameters field:Format.Field The field to fix when iterating. ICU Status Stable since ICU 64.

public void constrainField(Format.Field field)

Sets a constraint on the field. When this instance of ConstrainedFieldPosition is passed to FormattedValue#nextPosition, positions are skipped unless they have the given field. Any previously set constraints are cleared. For example, to loop over all grouping separators:

ConstrainedFieldPosition cfpos;
cfpos.constrainField(NumberFormat.Field.GROUPING_SEPARATOR);
while (fmtval.nextPosition(cfpos)) {
  // handle the grouping separator position
}

Changing the constraint while in the middle of iterating over a FormattedValue does not generally have well-defined behavior.

Parameters

field:Format.Field: The field to fix when iterating.

ICU Status

Stable since ICU 64.

constrainFieldAndValue back to summary

constrainFieldAndValue	back to summary
public void constrainFieldAndValue(Format.Field field, Object fieldValue) Deprecated This API is for technology preview and might be changed or removed in a future release. Sets a constraint on field and field value. When this instance of ConstrainedFieldPosition is passed to `FormattedValue#nextPosition`, positions are skipped unless both the field and the field value are equal. Any previously set constraints are cleared. For example, to find the span a date interval corresponding to the first date: ConstrainedFieldPosition cfpos; cfpos.constrainFieldAndValue(DateIntervalFormat.SpanField.DATE_INTERVAL_SPAN, 0); while (fmtval.nextPosition(cfpos)) { // handle the span of the first date in the date interval } Parameters field:Format.Field The field to fix when iterating. fieldValue:Object The field value to fix when iterating. Annotations @Deprecated ICU Status Internal ICU component: 64 technology preview

public void constrainFieldAndValue(Format.Field field, Object fieldValue)

Deprecated

This API is for technology preview and might be changed or removed in a future release.

Sets a constraint on field and field value. When this instance of ConstrainedFieldPosition is passed to FormattedValue#nextPosition, positions are skipped unless both the field and the field value are equal. Any previously set constraints are cleared. For example, to find the span a date interval corresponding to the first date:

ConstrainedFieldPosition cfpos;
cfpos.constrainFieldAndValue(DateIntervalFormat.SpanField.DATE_INTERVAL_SPAN, 0);
while (fmtval.nextPosition(cfpos)) {
  // handle the span of the first date in the date interval
}

Parameters

field:Format.Field: The field to fix when iterating.
fieldValue:Object: The field value to fix when iterating.

Annotations

@Deprecated

ICU Status

Internal ICU component: 64 technology preview

getField	back to summary
public Format.Field getField() Gets the field for the current position. The return value is well-defined and non-null only after FormattedValue#nextPosition returns true. Returns:Format.Field The field saved in the instance. See above for null conditions. ICU Status Stable since ICU 64.

getField

back to summary

public Format.Field getField()

Gets the field for the current position. The return value is well-defined and non-null only after FormattedValue#nextPosition returns true.

Returns:Format.Field: The field saved in the instance. See above for null conditions.
ICU Status: Stable since ICU 64.

getFieldValue	back to summary
public Object getFieldValue() Gets the value associated with the current field position. The field value is often not set. The return value is well-defined only after FormattedValue#nextPosition returns true. Returns:Object The value for the current position. Might be null. ICU Status Stable since ICU 64.

getFieldValue

back to summary

public Object getFieldValue()

Gets the value associated with the current field position. The field value is often not set. The return value is well-defined only after FormattedValue#nextPosition returns true.

Returns:Object: The value for the current position. Might be null.
ICU Status: Stable since ICU 64.

getInt64IterationContext back to summary

getInt64IterationContext	back to summary
public long getInt64IterationContext() Gets an int64 that FormattedValue implementations may use for storage. The initial value is zero. Users of FormattedValue should not need to call this method. Returns:long The current iteration context from `setInt64IterationContext`. ICU Status Stable since ICU 64.

public long getInt64IterationContext()

Gets an int64 that FormattedValue implementations may use for storage. The initial value is zero. Users of FormattedValue should not need to call this method.

Returns:long: The current iteration context from setInt64IterationContext.
ICU Status: Stable since ICU 64.

getLimit	back to summary
public int getLimit() Gets the EXCLUSIVE end index stored for the current position. The return value is well-defined only after FormattedValue#nextPosition returns true. Returns:int The end index saved in the instance. ICU Status Stable since ICU 64.

getLimit

back to summary

public int getLimit()

Gets the EXCLUSIVE end index stored for the current position. The return value is well-defined only after FormattedValue#nextPosition returns true.

Returns:int: The end index saved in the instance.
ICU Status: Stable since ICU 64.

getStart	back to summary
public int getStart() Gets the INCLUSIVE start index for the current position. The return value is well-defined only after FormattedValue#nextPosition returns true. Returns:int The start index saved in the instance. ICU Status Stable since ICU 64.

getStart

back to summary

public int getStart()

Gets the INCLUSIVE start index for the current position. The return value is well-defined only after FormattedValue#nextPosition returns true.

Returns:int: The start index saved in the instance.
ICU Status: Stable since ICU 64.

matchesField	back to summary
public boolean matchesField(Format.Field field, Object fieldValue) Determines whether a given field and value should be included given the constraints. Intended to be used by FormattedValue implementations. Parameters field:Format.Field The field to test. fieldValue:Object The field value to test. Should be null if there is no value. Returns:boolean Whether the field should be included given the constraints. ICU Status Stable since ICU 64.

matchesField

back to summary

public boolean matchesField(Format.Field field, Object fieldValue)

Determines whether a given field and value should be included given the constraints. Intended to be used by FormattedValue implementations.

Parameters

field:Format.Field: The field to test.
fieldValue:Object: The field value to test. Should be null if there is no value.

Returns:boolean

Whether the field should be included given the constraints.

ICU Status

Stable since ICU 64.

reset	back to summary
public void reset() Resets this ConstrainedFieldPosition to its initial state, as if it were newly created: - Removes any constraints that may have been set on the instance. - Resets the iteration position. ICU Status Stable since ICU 64.

reset

back to summary

public void reset()

Resets this ConstrainedFieldPosition to its initial state, as if it were newly created: - Removes any constraints that may have been set on the instance. - Resets the iteration position.

ICU Status: Stable since ICU 64.

setInt64IterationContext	back to summary
public void setInt64IterationContext(long context) Sets an int64 that FormattedValue implementations may use for storage. Intended to be used by FormattedValue implementations. Parameters context:long The new iteration context. ICU Status Stable since ICU 64.

setInt64IterationContext

back to summary

public void setInt64IterationContext(long context)

Sets an int64 that FormattedValue implementations may use for storage. Intended to be used by FormattedValue implementations.

Parameters

context:long: The new iteration context.

ICU Status

Stable since ICU 64.

setState	back to summary
public void setState(Format.Field field, Object value, int start, int limit) Sets new values for the primary public getters. Intended to be used by FormattedValue implementations. It is up to the implementation to ensure that the user-requested constraints are satisfied. This method does not check! Parameters field:Format.Field The new field. value:Object The new field value. Should be null if there is no value. start:int The new inclusive start index. limit:int The new exclusive end index. ICU Status Stable since ICU 64.

setState

back to summary

public void setState(Format.Field field, Object value, int start, int limit)

Sets new values for the primary public getters. Intended to be used by FormattedValue implementations. It is up to the implementation to ensure that the user-requested constraints are satisfied. This method does not check!

Parameters

field:Format.Field: The new field.
value:Object: The new field value. Should be null if there is no value.
start:int: The new inclusive start index.
limit:int: The new exclusive end index.

ICU Status

Stable since ICU 64.

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 ICU Status Stable since ICU 64.

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

ICU Status

Stable since ICU 64.

com.ibm.icu.text back to summary

private final Enum ConstrainedFieldPosition.ConstraintType

Class Inheritance

extends Enum<ConstrainedFieldPosition.ConstraintType>

java.lang.Object
java.lang.Enum
com.ibm.icu.text.ConstrainedFieldPosition.ConstraintType

Represents the type of constraint for ConstrainedFieldPosition. Constraints are used to control the behavior of iteration in FormattedValue.

Field Summary

Modifier and Type	Field and Description
public static final ConstrainedFieldPosition.ConstraintType	CLASS Represents that the field class is constrained.
public static final ConstrainedFieldPosition.ConstraintType	FIELD Represents that the field is constrained.
public static final ConstrainedFieldPosition.ConstraintType	NONE Represents the lack of a constraint.
public static final ConstrainedFieldPosition.ConstraintType	VALUE Represents that the field value is constrained.

Constructor Summary

Access	Constructor and Description
private	ConstraintType()

Method Summary

Modifier and Type	Method and Description
public static ConstrainedFieldPosition.ConstraintType	valueOf(String name)
public static ConstrainedFieldPosition.ConstraintType[]	values()

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

Field Detail

CLASS	back to summary
public static final ConstrainedFieldPosition.ConstraintType CLASS Represents that the field class is constrained. This is the value of fConstraint after `constrainClass` is called. FormattedValue implementations should not change the field class when this constraint is active.

FIELD	back to summary
public static final ConstrainedFieldPosition.ConstraintType FIELD Represents that the field is constrained. This is the value of fConstraint after `constrainField` is called. FormattedValue implementations should not change the field when this constraint is active.

NONE	back to summary
public static final ConstrainedFieldPosition.ConstraintType NONE Represents the lack of a constraint. This is the value of fConstraint if no "constrain" methods were called.

VALUE	back to summary
public static final ConstrainedFieldPosition.ConstraintType VALUE Represents that the field value is constrained. This is the value of fConstraint after `constrainField` is called. FormattedValue implementations should not change the field or value with this constraint.

Constructor Detail

ConstraintType	back to summary
private ConstraintType()

Method Detail

valueOf	back to summary
public static ConstrainedFieldPosition.ConstraintType valueOf(String name)

values	back to summary
public static ConstrainedFieldPosition.ConstraintType[] values()

public Class ConstrainedFieldPosition

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum ConstrainedFieldPosition.ConstraintType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail