Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class NameXPxg

extends OperandPtg
implements Pxg
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.ptg.Pxg
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.SheetNameFormatter, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
A Name, be that a Named Range or a Function / User Defined Function, addressed in the HSSF External Sheet style.

This is XSSF only, as it stores the sheet / book references in String form. The HSSF equivalent using indexes is NameXPtg

Field Summary

Modifier and TypeField and Description
private int
externalWorkbookNumber

private String
nameName

private String
sheetName

Constructor Summary

AccessConstructor and Description
public
NameXPxg(int externalWorkbookNumber, String sheetName, String nameName)

public
NameXPxg(NameXPxg other)

public
NameXPxg(String sheetName, String nameName)

public
NameXPxg(String nameName)

Method Summary

Modifier and TypeMethod and Description
public NameXPxg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public byte
getDefaultOperandClass()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getDefaultOperandClass.

public int
getExternalWorkbookNumber()

Implements org.apache.poi.ss.formula.ptg.Pxg.getExternalWorkbookNumber.

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public String
getNameName()

public String
getSheetName()

Implements org.apache.poi.ss.formula.ptg.Pxg.getSheetName.

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public void
setSheetName(String sheetName)

Implements org.apache.poi.ss.formula.ptg.Pxg.setSheetName.

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Implements org.apache.poi.ss.formula.ptg.Pxg.toFormulaString.

return a string representation of this token alone

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.OperandPtg:
isBaseToken

Field Detail

externalWorkbookNumberback to summary
private int externalWorkbookNumber
nameNameback to summary
private String nameName
sheetNameback to summary
private String sheetName

Constructor Detail

NameXPxgback to summary
public NameXPxg(int externalWorkbookNumber, String sheetName, String nameName)
NameXPxgback to summary
public NameXPxg(NameXPxg other)
NameXPxgback to summary
public NameXPxg(String sheetName, String nameName)
NameXPxgback to summary
public NameXPxg(String nameName)

Method Detail

copyback to summary
public NameXPxg copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:NameXPxg

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDefaultOperandClassback to summary
public byte getDefaultOperandClass()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getDefaultOperandClass.

Annotations
@Override
getExternalWorkbookNumberback to summary
public int getExternalWorkbookNumber()

Implements org.apache.poi.ss.formula.ptg.Pxg.getExternalWorkbookNumber.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getNameNameback to summary
public String getNameName()
getSheetNameback to summary
public String getSheetName()

Implements org.apache.poi.ss.formula.ptg.Pxg.getSheetName.

getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

structure id of the parsed thing, or -1 if the record has no sid

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

the encoded length of this Ptg, including the initial Ptg type identifier byte.

setSheetNameback to summary
public void setSheetName(String sheetName)

Implements org.apache.poi.ss.formula.ptg.Pxg.setSheetName.

toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Implements org.apache.poi.ss.formula.ptg.Pxg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.