org.apache.poi.ss.formula.ptg

## Class NamePtg

- java.lang.Object
- - org.apache.poi.ss.formula.ptg.Ptg
  - - org.apache.poi.ss.formula.ptg.OperandPtg
    - - org.apache.poi.ss.formula.ptg.NamePtg

- All Implemented Interfaces:
    Duplicatable, WorkbookDependentFormula

      public final class NamePtg
      extends OperandPtg
      implements WorkbookDependentFormula

  See the spec at 2.5.198.76 PtgName

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static short` | `sid`

    - ### Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg

      `CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `NamePtg(int nameIndex)`
    `NamePtg(LittleEndianInput in)` Creates new NamePtg
    `NamePtg(NamePtg other)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `NamePtg` | `copy()`
    `byte` | `getDefaultOperandClass()`
    `int` | `getIndex()`
    `int` | `getSize()`
    `java.lang.String` | `toFormulaString()` return a string representation of this token alone
    `java.lang.String` | `toFormulaString(FormulaRenderingWorkbook book)`
    `void` | `write(LittleEndianOutput out)`

    - ### Methods inherited from class org.apache.poi.ss.formula.ptg.OperandPtg

      `isBaseToken`

    - ### Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg

      `createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass, toString`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### sid

          public static final short sid

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### NamePtg

          public NamePtg(int nameIndex)

      Parameters:
        `nameIndex` - zero-based index to name within workbook

    - #### NamePtg

          public NamePtg(NamePtg other)

    - #### NamePtg

          public NamePtg(LittleEndianInput in)

      Creates new NamePtg

  - ### Method Detail

    - #### getIndex

          public int getIndex()

      Returns:
        zero based index to a defined name record in the LinkTable

    - #### write

          public void write(LittleEndianOutput out)

      Specified by:
        `write` in class `Ptg`

    - #### getSize

          public int getSize()

      Specified by:
        `getSize` in class `Ptg`
      Returns:
        the encoded length of this Ptg, including the initial Ptg type identifier byte.

    - #### toFormulaString

          public java.lang.String toFormulaString(FormulaRenderingWorkbook book)

      Specified by:
        `toFormulaString` in interface `WorkbookDependentFormula`

    - #### toFormulaString

          public java.lang.String toFormulaString()

      Description copied from class: `Ptg`
      return a string representation of this token alone
      Specified by:
        `toFormulaString` in class `Ptg`

    - #### getDefaultOperandClass

          public byte getDefaultOperandClass()

      Specified by:
        `getDefaultOperandClass` in class `Ptg`

    - #### copy

          public NamePtg copy()

      Specified by:
        `copy` in interface `Duplicatable`
      Specified by:
        `copy` in class `OperandPtg`
      Returns:
        a deep copy of the implementing class / instance

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.