Top Description Fields Constructors Methods
org.apache.poi.ss.format

public Class CellNumberStringMod

extends Object
implements Comparable<CellNumberStringMod>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Annotations
@Internal
Imports
org.apache.poi.ss.format.CellNumberFormatter.Special, org.apache.poi.util.Internal

Internal helper class for CellNumberFormatter This class represents a single modification to a result string. The way this works is complicated, but so is numeric formatting. In general, for most formats, we use a DecimalFormat object that will put the string out in a known format, usually with all possible leading and trailing zeros. We then walk through the result and the original format, and note any modifications that need to be made. Finally, we go through and apply them all, dealing with overlapping modifications.

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
private CellNumberFormatter.Special
private boolean
private final int
public static final int
private final CellNumberFormatter.Special
private boolean
private CharSequence

Constructor Summary

AccessConstructor and Description
public
public
CellNumberStringMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive, char toAdd)

public
CellNumberStringMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(CellNumberStringMod
the object to be compared.
that
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
that
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public CellNumberFormatter.Special
public int
public CellNumberFormatter.Special
public CharSequence
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public boolean
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

AFTERback to summary
public static final int AFTER
BEFOREback to summary
public static final int BEFORE
endback to summary
private CellNumberFormatter.Special end
endInclusiveback to summary
private boolean endInclusive
opback to summary
private final int op
REPLACEback to summary
public static final int REPLACE
specialback to summary
private final CellNumberFormatter.Special special
startInclusiveback to summary
private boolean startInclusive
toAddback to summary
private CharSequence toAdd

Constructor Detail

CellNumberStringModback to summary
public CellNumberStringMod(CellNumberFormatter.Special special, CharSequence toAdd, int op)
CellNumberStringModback to summary
public CellNumberStringMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive, char toAdd)
CellNumberStringModback to summary
public CellNumberStringMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive)

Method Detail

compareToback to summary
public int compareTo(CellNumberStringMod that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
that:CellNumberStringMod

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object that)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
that:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getEndback to summary
public CellNumberFormatter.Special getEnd()
getOpback to summary
public int getOp()
getSpecialback to summary
public CellNumberFormatter.Special getSpecial()
getToAddback to summary
public CharSequence getToAdd()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isEndInclusiveback to summary
public boolean isEndInclusive()
isStartInclusiveback to summary
public boolean isStartInclusive()