Package ch.rabanti.nanoxlsx4j

Class Address

java.lang.Object
ch.rabanti.nanoxlsx4j.Address
All Implemented Interfaces:
Comparable<Address>
public class Address extends Object implements Comparable<Address>
Class representing a cell address (no getters and setters to simplify handling)
Author:
Raphael Stoeckli

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final int
    Column
    Column of the address (zero-based)
    final int
    Row
    Row of the address (zero-based)
    final Cell.AddressType
    Type
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Address(int column, int row)
    Constructor with row and column as arguments.
    Address(int column, int row, Cell.AddressType type)
    Constructor with row, column and address type as arguments
    Address(String address)
    Constructor with address as string.
    Address(String address, Cell.AddressType type)
    Constructor with address as string.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(Address other)
    Compares two addresses and returns whether the passed one is bigger or not.
    boolean
    equals(Object o)
    Compares two addresses whether they are equal.
    String
    getAddress()
    Gets the address as string
    String
    getColumn()
    Gets the column address (A - XFD)
    int
    hashCode()
    Gets the hash code of the address based on its string representation
    String
    toString()
    Returns the address as string or "Illegal Address" in case of an exception

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • Column

      public final int Column
      Column of the address (zero-based)

    • Row

      public final int Row
      Row of the address (zero-based)

    • Type

      public final Cell.AddressType Type

  • Constructor Details

    • Address

      public Address(int column, int row)
      Constructor with row and column as arguments. The referencing type of the address is default (e.g. 'C20')
      Parameters:
      column - Column of the address (zero-based)
      row - Row of the address (zero-based)
      Throws:
      RangeException - Thrown if the resolved address is out of range

    • Address

      public Address(int column, int row, Cell.AddressType type)
      Constructor with row, column and address type as arguments
      Parameters:
      column - Column of the address (zero-based)
      row - Row of the address (zero-based)
      type - Referencing type of the address
      Throws:
      RangeException - Thrown if the resolved address is out of range

    • Address

      public Address(String address)
      Constructor with address as string. If no referencing modifiers ($) are defined, the address is of referencing type default (e.g. 'C23')
      Parameters:
      address - Address string (e.g. 'B12')
      Throws:
      RangeException - Thrown if the resolved address is out of range

    • Address

      public Address(String address, Cell.AddressType type)
      Constructor with address as string. All referencing modifiers ($) are ignored and only the defined referencing type considered
      Parameters:
      address - Address string (e.g. 'B12')
      type - Referencing type of the address
      Throws:
      RangeException - Thrown if the resolved address is out of range

  • Method Details

    • getAddress

      public String getAddress()
      Gets the address as string
      Returns:
      Address as string
      Throws:
      RangeException - Thrown if the column or row is out of range

    • getColumn

      public String getColumn()
      Gets the column address (A - XFD)
      Returns:
      Column address as letter(s)

    • toString

      public String toString()
      Returns the address as string or "Illegal Address" in case of an exception
      Overrides:
      toString in class Object
      Returns:
      Address or notification in case of an error

    • equals

      public boolean equals(Object o)
      Compares two addresses whether they are equal. The address type id neglected, only the row and column is considered
      Overrides:
      equals in class Object
      Parameters:
      o - Address to compare
      Returns:
      True if equal

    • hashCode

      public int hashCode()
      Gets the hash code of the address based on its string representation
      Overrides:
      hashCode in class Object
      Returns:
      Hash code of the address

    • compareTo

      public int compareTo(Address other)
      Compares two addresses and returns whether the passed one is bigger or not. Bigger means: Higher column number and / or higher row number
      Specified by:
      compareTo in interface Comparable<Address>
      Parameters:
      other - Other address to compare
      Returns:
      1 If the other address is bigger, -1 if it is smaller and 0 ist it is equal