Package ch.rabanti.picoxlsx4j

Class Range

  • public class Range
extends java.lang.Object
    Class representing a cell range (no getters and setters to simplify handling)

    • Constructor Summary

      Constructors 
      Constructor Description
      Range​(Address start, Address end)
      Constructor with with addresses as arguments
      Range​(java.lang.String range)
      Constructor with a range string as argument

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Range buildRange​(int startColumn, int startRow, int endColumn, int endRow)
      Method to build a range object from zwo column and two row numbers.
      static Range buildRange​(Address startAddress, Address endAddress)
      Method to build a range object from two addresses.
      boolean equals​(java.lang.Object o)
      Overwritten equals method
      java.lang.String toString()
      Overwritten toString method

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • EndAddress

        public final Address EndAddress
        End address of the range

      • StartAddress

        public final Address StartAddress
        Start address of the range

    • Constructor Detail

      • Range

        public Range​(Address start,
             Address end)
        Constructor with with addresses as arguments
        Parameters:
        start - Start address of the range
        end - End address of the range
        Throws:
        RangeException - Thrown if the end address is smaller than the start address

      • Range

        public Range​(java.lang.String range)
        Constructor with a range string as argument
        Parameters:
        range - Address range (e.g. 'A1:B12')
        Throws:
        RangeException - Thrown if the end address is smaller than the start address

    • Method Detail

      • toString

        public java.lang.String toString()
        Overwritten toString method
        Overrides:
        toString in class java.lang.Object
        Returns:
        Returns the range (e.g. 'A1:B12')

      • equals

        public boolean equals​(java.lang.Object o)
        Overwritten equals method
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - Other object to compare
        Returns:
        True if this instance is equal to the other instance

      • buildRange

        public static Range buildRange​(Address startAddress,
                               Address endAddress)
        Method to build a range object from two addresses. The appropriate start and end address will be determined automatically
        Parameters:
        startAddress - Proposed start address
        endAddress - Proposed end address
        Returns:
        Resolved Range

      • buildRange

        public static Range buildRange​(int startColumn,
                               int startRow,
                               int endColumn,
                               int endRow)
        Method to build a range object from zwo column and two row numbers. The appropriate start and end address will be determined automatically
        Parameters:
        startColumn - Proposed start column
        startRow - Proposed start row
        endColumn - Proposed end column
        endRow - Proposed end row
        Returns:
        Resolved Range