Module org.jfree.chart

Package org.jfree.chart.axis

Class CompassFormat

java.lang.Object

java.text.Format

java.text.NumberFormat

org.jfree.chart.axis.CompassFormat

All Implemented Interfaces:

Serializable, Cloneable

public class CompassFormat
extends NumberFormat

A formatter that displays numbers as directions.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.NumberFormat

NumberFormat.Field

Field Summary

Fields

Modifier and Type	Field	Description
String[]	directions	The directions.

Fields inherited from class java.text.NumberFormat

FRACTION_FIELD, INTEGER_FIELD

Constructor Summary

Constructors

Constructor	Description
CompassFormat()	Creates a new formatter using English identifiers.
CompassFormat(String[] directions)	Creates a new formatter using the specified identifiers.
CompassFormat(String n, String e, String s, String w)	Creates a new formatter using the specified identifiers for the base wind directions.

Method Summary

Modifier and Type	Method	Description
StringBuffer	format(double number, StringBuffer toAppendTo, FieldPosition pos)	Formats a number into the specified string buffer.
StringBuffer	format(long number, StringBuffer toAppendTo, FieldPosition pos)	Formats a number into the specified string buffer.
String	getDirectionCode(double direction)	Returns a string representing the direction.
Number	parse(String source, ParsePosition parsePosition)	This method returns null for all inputs.

Methods inherited from class java.text.NumberFormat

clone, equals, format, format, format, getAvailableLocales, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, getRoundingMode, hashCode, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode

Methods inherited from class java.text.Format

format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

directions

public final String[] directions

The directions.

Constructor Detail

CompassFormat

public CompassFormat()

Creates a new formatter using English identifiers.

CompassFormat

public CompassFormat(String n,
                     String e,
                     String s,
                     String w)

Creates a new formatter using the specified identifiers for the base wind directions.

Parameters:

n - the code for NORTH.

e - the code for EAST.

s - the code for SOUTH.

w - the code for WEST.

CompassFormat

public CompassFormat(String[] directions)

Creates a new formatter using the specified identifiers.

Parameters:

directions - an array containing 16 strings representing the directions of a compass.

Method Detail

getDirectionCode

public String getDirectionCode(double direction)

Returns a string representing the direction.

Parameters:

direction - the direction.

Returns:

A string.

format

public StringBuffer format(double number,
                           StringBuffer toAppendTo,
                           FieldPosition pos)

Formats a number into the specified string buffer.

Specified by:

format in class NumberFormat

Parameters:

number - the number to format.

toAppendTo - the string buffer.

pos - the field position (ignored here).

Returns:

The string buffer.

format

public StringBuffer format(long number,
                           StringBuffer toAppendTo,
                           FieldPosition pos)

Formats a number into the specified string buffer.

Specified by:

format in class NumberFormat

Parameters:

number - the number to format.

toAppendTo - the string buffer.

pos - the field position (ignored here).

Returns:

The string buffer.

parse

public Number parse(String source,
                    ParsePosition parsePosition)

This method returns null for all inputs. This class cannot be used for parsing.

Specified by:

parse in class NumberFormat

Parameters:

source - the source string.

parsePosition - the parse position.

Returns:

null.