Class OraDecimalFormat

    • Constructor Detail

      • OraDecimalFormat

        public OraDecimalFormat()
        Deprecated.
        As of Oracle Database 10g Release 2 (10.2), replaced by OraDecimalFormat(String, OraDecimalFormatSymbols)
        Constructs an OraDecimalFormat object using the default number format pattern and the default decimal format symbols for the default locale.
      • OraDecimalFormat

        public OraDecimalFormat​(String pattern)
                         throws ParseException
        Deprecated.
        As of Oracle Database 10g Release 2 (10.2), replaced by OraDecimalFormat(String, OraDecimalFormatSymbols)
        Constructs an OraDecimalFormat object using the given format pattern and the default decimal format symbols for the default locale.
        Parameters:
        pattern - the given format pattern, if null, uses the default number format pattern for the default locale and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
        Throws:
        ParseException - if the given pattern is invalid
      • OraDecimalFormat

        public OraDecimalFormat​(String pattern,
                                OraDecimalFormatSymbols symbols)
                         throws ParseException
        Constructs an OraDecimalFormat object using the given format pattern and the given decimal format symbols.
        Parameters:
        pattern - the give format pattern, if null, uses the default number format pattern for the default locale and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
        symbols - the given decimal format symbols
        Throws:
        ParseException - if the given pattern is invalid
    • Method Detail

      • applyPattern

        public void applyPattern​(String pattern)
                          throws ParseException
        Modifies this formatter by using the given format pattern. The given format pattern should be specified as:
          "<positive pattern>[;<negative pattern>]"
        This means that a positive format pattern must be present but a negative format pattern is optional. If there is no negative pattern given, the positive pattern with a leading minus sign is used for formatting or parsing negative numbers.
        Parameters:
        pattern - given format pattern, if null, uses the default number format pattern for the default locale and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
        Throws:
        ParseException - if the given pattern is invalid
      • format

        public StringBuffer format​(BigDecimal number,
                                   StringBuffer toAppendTo,
                                   FieldPosition fieldPosition)
        Formats a BigDecimal object into a string. Sets field position if it is needed.
        Specified by:
        format in class OraNumberFormat
        Parameters:
        number - the BigDecimal object to be formatted.
        toAppendTo - the string buffer to be appended with the formatted string.
        fieldPosition - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
        Returns:
        the string buffer appended with a formatted string
      • format

        public StringBuffer format​(BigInteger number,
                                   StringBuffer toAppendTo,
                                   FieldPosition fieldPosition)
        Formats a BigInteger object into a string. Sets field position if it is needed.
        Specified by:
        format in class OraNumberFormat
        Parameters:
        number - the BigInteger object to be formatted.
        toAppendTo - the string buffer to be appended with the formatted string.
        fieldPosition - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
        Returns:
        the string buffer appended with a formatted string
      • format

        public StringBuffer format​(double number,
                                   StringBuffer toAppendTo,
                                   FieldPosition fieldPosition)
        Formats a double number into a string. Sets field position if it is needed.
        Specified by:
        format in class OraNumberFormat
        Parameters:
        number - the double number to be formatted.
        toAppendTo - the string buffer to be appended with the formatted string.
        fieldPosition - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
        Returns:
        the string buffer appended with a formatted string
      • format

        public StringBuffer format​(long number,
                                   StringBuffer toAppendTo,
                                   FieldPosition fieldPosition)
        Formats a long number into a string. Sets field position if it is needed.
        Specified by:
        format in class OraNumberFormat
        Parameters:
        number - the long number to be formatted.
        toAppendTo - the string buffer to be appended with the formatted string.
        fieldPosition - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
        Returns:
        the string buffer appended with a formatted string
      • parse

        public Number parse​(String text,
                            ParsePosition parsePosition)
        Parses a string into a Number object, starting from the given parse position.
        Specified by:
        parse in class OraNumberFormat
        Parameters:
        text - the string
        parsePosition - indicates where to start the parsing on input. On output, returns where the parse ends if parsing succeeds, or the start index if it fails.
        Returns:
        a Number object
      • isDecimalSeparatorAlwaysShown

        public boolean isDecimalSeparatorAlwaysShown()
        Returns true if decimal separator is always shown in the result string.
        Returns:
        a boolean value
      • setDecimalSeparatorAlwaysShown

        public void setDecimalSeparatorAlwaysShown​(boolean val)
        Sets the switch for decimal separator to the given boolean value.
        Parameters:
        val - the given boolean value
      • getOraDecimalFormatSymbols

        public OraDecimalFormatSymbols getOraDecimalFormatSymbols()
        Returns the Oracle decimal format symbols used in this formatter.
        Returns:
        an OraDecimalFormatSymbols object
        See Also:
        OraDecimalFormatSymbols
      • setOraDecimalFormatSymbols

        public void setOraDecimalFormatSymbols​(OraDecimalFormatSymbols sym)
        Sets this formatter to use the given Oracle decimal format symbols.
        Parameters:
        sym - the given Oracle decimal format symbols
      • toPattern

        public String toPattern()
        Returns a format pattern string that represents the formatting behavior of this formatter.
        Returns:
        a format pattern string
      • equals

        public boolean equals​(Object object)
        Overrides the equals method.
        Overrides:
        equals in class OraNumberFormat
        Parameters:
        object - an object to be compared
        Returns:
        true if two objects are identical, otherwise false
      • hashCode

        public int hashCode()
        Overrides the hashCode method.
        Overrides:
        hashCode in class Object
        Returns:
        a hash value for the object