OpenJDK 27 · com.sun.org.apache.xpath.internal.compiler.OpMap

Modifier and Type	Field and Description
pack-priv static final int	BLOCKTOKENQUEUESIZE
protected String	m_currentPattern The current pattern string, for diagnostics purposes
pack-priv OpMapVector	m_opMap An operations map is used instead of a proper parse tree.
pack-priv ObjectVector	m_tokenQueue TokenStack is the queue of used tokens.
public static final int	MAPINDEX_LENGTH The length is always the opcode position + 1.
pack-priv static final int	MAXTOKENQUEUESIZE The starting size of the token queue.

Access	Constructor and Description
public	OpMap()

Method Summary

Modifier and Type	Method and Description
public void	error(String An error msgkey that corresponds to one of the constants found in `com.sun.org.apache.xpath.internal.res.XPATHErrorResources`, which is a key for a format string. msg, Object[] An array of arguments represented in the format string, which may be null. args) Tell the user of an error, and probably throw an exception.
public int	Returns: The size of the operation. getArgLength(int The position of the operation in the op map. opPos) Get the length of an operation.
public int	Returns: The length of the step. getArgLengthOfStep(int Position of location step in op map. opPos) Given a location step, get the length of that step.
public static int	Returns: The position of the first child of the operation. getFirstChildPos(int position of operation. opPos) Go to the first child of a given operation.
public static int	Returns: The first child position of the step. getFirstChildPosOfStep(int Position of location step in the location map. opPos) Get the first child position of a given location step.
public int	Returns: position of predicate in FROM_stepType structure. getFirstPredicateOpPos(int position of FROM_stepType op. opPos) Given an FROM_stepType position, return the position of the first predicate, if there is one, or else this will point to the end of the FROM_stepType.
public int	Returns: position of next operation in m_opMap. getNextOpPos(int An op position of an operation for which there is a size entry following. opPos) Given an operation position, return the end position, i.e. the beginning of the next operation.
public static int	Returns: position of next operation in m_opMap. getNextOpPos(int[] The operations map. opMap, int index to operation, for which there is a size entry following. opPos) Given an operation position, return the end position, i.e. the beginning of the next operation.
public int	Returns: the position of the next location step. getNextStepPos(int the position of a location step. opPos) Given a location step position, return the end position, i.e. the beginning of the next step.
public int	Returns: the op that corresponds to the opPos argument. getOp(int index into op map. opPos) Given an operation position, return the current op.
public OpMapVector	Returns: An IntVector that is the opcode list that describes the XPath operations. getOpMap() Get the opcode list that describes the XPath operations.
public String	Returns: The expression string. getPatternString() Return the expression as a string for diagnostics.
public String	Returns: OpCodes.EMPTY, OpCodes.ELEMWILDCARD, or the local name. getStepLocalName(int The position of the FROM_XXX step. opPosOfStep) Get the local name of the step.
public String	Returns: The step's namespace, NodeTest.WILD, or null for null namespace. getStepNS(int The position of the FROM_XXX step. opPosOfStep) Get the namespace of the step.
public int	Returns: NODETYPE_XXX value. getStepTestType(int The position of the FROM_XXX step. opPosOfStep) Get the test type of the step, i.e. NODETYPE_XXX value.
public Object	Returns: The token, normally a string. getToken(int index into token queue. pos) Get the XPath as a list of tokens.
public ObjectVector	Returns: ObjectVector of tokens. getTokenQueue() Get the XPath as a list of tokens.
public int	Returns: The size of the token queue. getTokenQueueSize() Get size of the token queue.
public void	setOp(int index into op map. opPos, int Value to set value) Set the op at index to the given int.
pack-priv void	shrink() Replace the large arrays with a small array.
public String	Returns: The expression string. toString() Overrides java.lang.Object.toString. Return the expression as a string for diagnostics.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

BLOCKTOKENQUEUESIZE	back to summary
pack-priv static final int BLOCKTOKENQUEUESIZE

m_currentPattern	back to summary
protected String m_currentPattern The current pattern string, for diagnostics purposes

m_opMap	back to summary
pack-priv OpMapVector m_opMap An operations map is used instead of a proper parse tree. It contains operations codes and indexes into the m_tokenQueue. I use an array instead of a full parse tree in order to cut down on the number of objects created.

m_tokenQueue	back to summary
pack-priv ObjectVector m_tokenQueue TokenStack is the queue of used tokens. The current token is the token at the end of the m_tokenQueue. The idea is that the queue can be marked and a sequence of tokens can be reused.

MAPINDEX_LENGTH	back to summary
public static final int MAPINDEX_LENGTH The length is always the opcode position + 1. Length is always expressed as the opcode+length bytes, so it is always 2 or greater.

MAXTOKENQUEUESIZE	back to summary
pack-priv static final int MAXTOKENQUEUESIZE The starting size of the token queue.

OpMap	back to summary
public OpMap()

Method Detail

error back to summary

error	back to summary
public void error(String msg, Object[] args) throws TransformerException Tell the user of an error, and probably throw an exception. Parameters msg:String An error msgkey that corresponds to one of the constants found in `com.sun.org.apache.xpath.internal.res.XPATHErrorResources`, which is a key for a format string. args:Object[] An array of arguments represented in the format string, which may be null. Exceptions TransformerException: if the current ErrorListoner determines to throw an exception.

public void error(String msg, Object[] args) throws TransformerException

Tell the user of an error, and probably throw an exception.

Parameters

msg:String: An error msgkey that corresponds to one of the constants found in com.sun.org.apache.xpath.internal.res.XPATHErrorResources, which is a key for a format string.
args:Object[]: An array of arguments represented in the format string, which may be null.

Exceptions

TransformerException:: if the current ErrorListoner determines to throw an exception.

getArgLength	back to summary
public int getArgLength(int opPos) Get the length of an operation. Parameters opPos:int The position of the operation in the op map. Returns:int The size of the operation.

getArgLength

back to summary

public int getArgLength(int opPos)

Get the length of an operation.

Parameters

opPos:int: The position of the operation in the op map.

Returns:int

The size of the operation.

getArgLengthOfStep	back to summary
public int getArgLengthOfStep(int opPos) Given a location step, get the length of that step. Parameters opPos:int Position of location step in op map. Returns:int The length of the step.

getArgLengthOfStep

back to summary

public int getArgLengthOfStep(int opPos)

Given a location step, get the length of that step.

Parameters

opPos:int: Position of location step in op map.

Returns:int

The length of the step.

getFirstChildPos	back to summary
public static int getFirstChildPos(int opPos) Go to the first child of a given operation. Parameters opPos:int position of operation. Returns:int The position of the first child of the operation.

getFirstChildPos

back to summary

public static int getFirstChildPos(int opPos)

Go to the first child of a given operation.

Parameters

opPos:int: position of operation.

Returns:int

The position of the first child of the operation.

getFirstChildPosOfStep	back to summary
public static int getFirstChildPosOfStep(int opPos) Get the first child position of a given location step. Parameters opPos:int Position of location step in the location map. Returns:int The first child position of the step.

getFirstChildPosOfStep

back to summary

public static int getFirstChildPosOfStep(int opPos)

Get the first child position of a given location step.

Parameters

opPos:int: Position of location step in the location map.

Returns:int

The first child position of the step.

getFirstPredicateOpPos	back to summary
public int getFirstPredicateOpPos(int opPos) throws TransformerException Given an FROM_stepType position, return the position of the first predicate, if there is one, or else this will point to the end of the FROM_stepType. Example: int posOfPredicate = xpath.getNextOpPos(stepPos); boolean hasPredicates = OpCodes.OP_PREDICATE == xpath.getOp(posOfPredicate); Parameters opPos:int position of FROM_stepType op. Returns:int position of predicate in FROM_stepType structure.

getFirstPredicateOpPos

back to summary

public int getFirstPredicateOpPos(int opPos) throws TransformerException

Given an FROM_stepType position, return the position of the first predicate, if there is one, or else this will point to the end of the FROM_stepType. Example: int posOfPredicate = xpath.getNextOpPos(stepPos); boolean hasPredicates = OpCodes.OP_PREDICATE == xpath.getOp(posOfPredicate);

Parameters

opPos:int: position of FROM_stepType op.

Returns:int

position of predicate in FROM_stepType structure.

getNextOpPos	back to summary
public int getNextOpPos(int opPos) Given an operation position, return the end position, i.e. the beginning of the next operation. Parameters opPos:int An op position of an operation for which there is a size entry following. Returns:int position of next operation in m_opMap.

getNextOpPos

back to summary

public int getNextOpPos(int opPos)

Given an operation position, return the end position, i.e. the beginning of the next operation.

Parameters

opPos:int: An op position of an operation for which there is a size entry following.

Returns:int

position of next operation in m_opMap.

getNextOpPos	back to summary
public static int getNextOpPos(int[] opMap, int opPos) Given an operation position, return the end position, i.e. the beginning of the next operation. Parameters opMap:int[] The operations map. opPos:int index to operation, for which there is a size entry following. Returns:int position of next operation in m_opMap.

getNextOpPos

back to summary

public static int getNextOpPos(int[] opMap, int opPos)

Given an operation position, return the end position, i.e. the beginning of the next operation.

Parameters

opMap:int[]: The operations map.
opPos:int: index to operation, for which there is a size entry following.

Returns:int

position of next operation in m_opMap.

getNextStepPos	back to summary
public int getNextStepPos(int opPos) Given a location step position, return the end position, i.e. the beginning of the next step. Parameters opPos:int the position of a location step. Returns:int the position of the next location step.

getNextStepPos

back to summary

public int getNextStepPos(int opPos)

Given a location step position, return the end position, i.e. the beginning of the next step.

Parameters

opPos:int: the position of a location step.

Returns:int

the position of the next location step.

getOp	back to summary
public int getOp(int opPos) Given an operation position, return the current op. Parameters opPos:int index into op map. Returns:int the op that corresponds to the opPos argument.

getOp

back to summary

public int getOp(int opPos)

Given an operation position, return the current op.

Parameters

opPos:int: index into op map.

Returns:int

the op that corresponds to the opPos argument.

getOpMap	back to summary
public OpMapVector getOpMap() Get the opcode list that describes the XPath operations. It contains operations codes and indexes into the m_tokenQueue. I use an array instead of a full parse tree in order to cut down on the number of objects created. Returns:OpMapVector An IntVector that is the opcode list that describes the XPath operations.

getOpMap

back to summary

public OpMapVector getOpMap()

Get the opcode list that describes the XPath operations. It contains operations codes and indexes into the m_tokenQueue. I use an array instead of a full parse tree in order to cut down on the number of objects created.

Returns:OpMapVector: An IntVector that is the opcode list that describes the XPath operations.

getPatternString	back to summary
public String getPatternString() Return the expression as a string for diagnostics. Returns:String The expression string.

getPatternString

back to summary

public String getPatternString()

Return the expression as a string for diagnostics.

Returns:String: The expression string.

getStepLocalName	back to summary
public String getStepLocalName(int opPosOfStep) Get the local name of the step. Parameters opPosOfStep:int The position of the FROM_XXX step. Returns:String OpCodes.EMPTY, OpCodes.ELEMWILDCARD, or the local name.

getStepLocalName

back to summary

public String getStepLocalName(int opPosOfStep)

Get the local name of the step.

Parameters

opPosOfStep:int: The position of the FROM_XXX step.

Returns:String

OpCodes.EMPTY, OpCodes.ELEMWILDCARD, or the local name.

getStepNS	back to summary
public String getStepNS(int opPosOfStep) Get the namespace of the step. Parameters opPosOfStep:int The position of the FROM_XXX step. Returns:String The step's namespace, NodeTest.WILD, or null for null namespace.

getStepNS

back to summary

public String getStepNS(int opPosOfStep)

Get the namespace of the step.

Parameters

opPosOfStep:int: The position of the FROM_XXX step.

Returns:String

The step's namespace, NodeTest.WILD, or null for null namespace.

getStepTestType	back to summary
public int getStepTestType(int opPosOfStep) Get the test type of the step, i.e. NODETYPE_XXX value. Parameters opPosOfStep:int The position of the FROM_XXX step. Returns:int NODETYPE_XXX value.

getStepTestType

back to summary

public int getStepTestType(int opPosOfStep)

Get the test type of the step, i.e. NODETYPE_XXX value.

Parameters

opPosOfStep:int: The position of the FROM_XXX step.

Returns:int

NODETYPE_XXX value.

getToken	back to summary
public Object getToken(int pos) Get the XPath as a list of tokens. Parameters pos:int index into token queue. Returns:Object The token, normally a string.

getToken

back to summary

public Object getToken(int pos)

Get the XPath as a list of tokens.

Parameters

pos:int: index into token queue.

Returns:Object

The token, normally a string.

getTokenQueue	back to summary
public ObjectVector getTokenQueue() Get the XPath as a list of tokens. Returns:ObjectVector ObjectVector of tokens.

getTokenQueue

back to summary

public ObjectVector getTokenQueue()

Get the XPath as a list of tokens.

Returns:ObjectVector: ObjectVector of tokens.

getTokenQueueSize	back to summary
public int getTokenQueueSize() Get size of the token queue. Returns:int The size of the token queue.

getTokenQueueSize

back to summary

public int getTokenQueueSize()

Get size of the token queue.

Returns:int: The size of the token queue.

setOp	back to summary
public void setOp(int opPos, int value) Set the op at index to the given int. Parameters opPos:int index into op map. value:int Value to set

setOp

back to summary

public void setOp(int opPos, int value)

Set the op at index to the given int.

Parameters

opPos:int: index into op map.
value:int: Value to set

shrink	back to summary
pack-priv void shrink() Replace the large arrays with a small array.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return the expression as a string for diagnostics. Returns:String The expression string.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return the expression as a string for diagnostics.

Returns:String: The expression string.

public Class OpMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail