Interface NumberFormatSpecifier
-
- All Superinterfaces:
org.eclipse.emf.ecore.EObject,FormatSpecifier,IChartObject,org.eclipse.emf.common.notify.Notifier
- All Known Implementing Classes:
NumberFormatSpecifierImpl
public interface NumberFormatSpecifier extends FormatSpecifier
A representation of the model object 'Number Format Specifier'. NumberFormatSpecifier extends FormatSpecifier specially for formatting numeric values.The following features are supported:
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description NumberFormatSpecifiercopyInstance()java.lang.Stringformat(double dValue, com.ibm.icu.util.ULocale lo)Formats a value using the internally defined format specifier rulesjava.lang.Stringformat(double dValue, java.util.Locale lo)Deprecated.java.lang.Stringformat(java.lang.Number number, com.ibm.icu.util.ULocale lo)Returns a formatted string representation of specified number.intgetFractionDigits()Returns the value of the 'Fraction Digits' attribute.doublegetMultiplier()Returns the value of the 'Multiplier' attribute.java.lang.StringgetPrefix()Returns the value of the 'Prefix' attribute.java.lang.StringgetSuffix()Returns the value of the 'Suffix' attribute.booleanisSetFractionDigits()Returns whether the value of the 'Fraction Digits' attribute is set.booleanisSetMultiplier()Returns whether the value of the 'Multiplier' attribute is set.voidsetFractionDigits(int value)Sets the value of the 'Fraction Digits' attribute.voidsetMultiplier(double value)Sets the value of the 'Multiplier' attribute.voidsetPrefix(java.lang.String value)Sets the value of the 'Prefix' attribute.voidsetSuffix(java.lang.String value)Sets the value of the 'Suffix' attribute.voidunsetFractionDigits()Unsets the value of the 'Fraction Digits' attribute.voidunsetMultiplier()Unsets the value of the 'Multiplier' attribute.
-
-
-
Method Detail
-
getPrefix
java.lang.String getPrefix()
Returns the value of the 'Prefix' attribute. Attribute "Prefix" specifies the prefix of the output text.- Returns:
- the value of the 'Prefix' attribute.
- See Also:
setPrefix(String),AttributePackage.getNumberFormatSpecifier_Prefix()
-
setPrefix
void setPrefix(java.lang.String value)
Sets the value of the 'Prefix' attribute.- Parameters:
value- the new value of the 'Prefix' attribute.- See Also:
getPrefix()
-
getSuffix
java.lang.String getSuffix()
Returns the value of the 'Suffix' attribute. Attribute "Suffix" specifies the suffix of the output text.- Returns:
- the value of the 'Suffix' attribute.
- See Also:
setSuffix(String),AttributePackage.getNumberFormatSpecifier_Suffix()
-
setSuffix
void setSuffix(java.lang.String value)
Sets the value of the 'Suffix' attribute.- Parameters:
value- the new value of the 'Suffix' attribute.- See Also:
getSuffix()
-
getMultiplier
double getMultiplier()
Returns the value of the 'Multiplier' attribute. Specifies the multiplier.- Returns:
- the value of the 'Multiplier' attribute.
- See Also:
isSetMultiplier(),unsetMultiplier(),setMultiplier(double),AttributePackage.getNumberFormatSpecifier_Multiplier()
-
setMultiplier
void setMultiplier(double value)
Sets the value of the 'Multiplier' attribute.- Parameters:
value- the new value of the 'Multiplier' attribute.- See Also:
isSetMultiplier(),unsetMultiplier(),getMultiplier()
-
unsetMultiplier
void unsetMultiplier()
Unsets the value of the 'Multiplier' attribute.- See Also:
isSetMultiplier(),getMultiplier(),setMultiplier(double)
-
isSetMultiplier
boolean isSetMultiplier()
Returns whether the value of the 'Multiplier' attribute is set.- Returns:
- whether the value of the 'Multiplier' attribute is set.
- See Also:
unsetMultiplier(),getMultiplier(),setMultiplier(double)
-
getFractionDigits
int getFractionDigits()
Returns the value of the 'Fraction Digits' attribute. Defines the number of fractional digits to be shown.- Returns:
- the value of the 'Fraction Digits' attribute.
- See Also:
isSetFractionDigits(),unsetFractionDigits(),setFractionDigits(int),AttributePackage.getNumberFormatSpecifier_FractionDigits()
-
setFractionDigits
void setFractionDigits(int value)
Sets the value of the 'Fraction Digits' attribute.- Parameters:
value- the new value of the 'Fraction Digits' attribute.- See Also:
isSetFractionDigits(),unsetFractionDigits(),getFractionDigits()
-
unsetFractionDigits
void unsetFractionDigits()
Unsets the value of the 'Fraction Digits' attribute.
-
isSetFractionDigits
boolean isSetFractionDigits()
Returns whether the value of the 'Fraction Digits' attribute is set.- Returns:
- whether the value of the 'Fraction Digits' attribute is set.
- See Also:
unsetFractionDigits(),getFractionDigits(),setFractionDigits(int)
-
format
@Deprecated java.lang.String format(double dValue, java.util.Locale lo)Deprecated.Formats a value using the internally defined format specifier rules- Parameters:
dValue-- Returns:
- A formatted string representation of the numerical value provided
-
format
java.lang.String format(double dValue, com.ibm.icu.util.ULocale lo)Formats a value using the internally defined format specifier rules- Parameters:
dValue-- Returns:
- A formatted string representation of the numerical value provided
- Since:
- 2.1
-
format
java.lang.String format(java.lang.Number number, com.ibm.icu.util.ULocale lo)Returns a formatted string representation of specified number.- Parameters:
number-lo-- Returns:
- Since:
- 2.6
-
copyInstance
NumberFormatSpecifier copyInstance()
- Specified by:
copyInstancein interfaceFormatSpecifier- Specified by:
copyInstancein interfaceIChartObject
-
-