Package com.itextpdf.text.pdf.spatial.units

Enum Square

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Square>
    public enum Square
extends java.lang.Enum<Square>
    Area display units for use in a Preferred Display Units (PDU) array.
    Since:
    5.1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String name
      The name used for the Square unit.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Square​(java.lang.String name)
      Creates a Square unit.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PdfName getPdfName()
      Gets the PdfName.
      static Square valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Square[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SQUARE_METER

        public static final Square SQUARE_METER
        a square meter

      • HECTARE

        public static final Square HECTARE
        a hectare (10,000 square meters)

      • SQUARE_KILOMETER

        public static final Square SQUARE_KILOMETER
        a square kilometer

      • SQUARE_FOOT

        public static final Square SQUARE_FOOT
        a square foot

      • ACRE

        public static final Square ACRE
        an acre

      • SQUARE_MILE

        public static final Square SQUARE_MILE
        a square mile

    • Field Detail

      • name

        private java.lang.String name
        The name used for the Square unit.

    • Constructor Detail

      • Square

        private Square​(java.lang.String name)
        Creates a Square unit.

    • Method Detail

      • values

        public static Square[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Square c : Square.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Square valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getPdfName

        public PdfName getPdfName()
        Gets the PdfName.