OpenJDK 27 · java.lang.classfile.attribute.CharacterRangeInfo

Method Summary

Modifier and Type	Method and Description
public int	Returns: the encoded end of character positions in the source file, exclusive characterRangeEnd() Returns the encoded end of character positions in the source file, exclusive.
public int	Returns: the encoded start of character positions in the source file, inclusive characterRangeStart() Returns the encoded start of character positions in the source file, inclusive.
public int	Returns: the end of indices in the code array, exclusive endPc() Returns the end of indices in the code array, exclusive.
public int	Returns: the flags of this character range entry flags() Returns the flags of this character range entry.
public static CharacterRangeInfo	Returns: a character range entry of(int the start of indices in the code array, inclusive startPc, int the end of indices in the code array, exclusive endPc, int the encoded start of character positions in the source file, inclusive characterRangeStart, int the encoded end of character positions in the source file, exclusive characterRangeEnd, int the flags of this entry flags) Returns a character range entry.
public int	Returns: the start of indices in the code array, inclusive startPc() Returns the start of indices in the code array, inclusive.

Method Detail

characterRangeEnd	back to summary
public int characterRangeEnd() Returns the encoded end of character positions in the source file, exclusive. Returns:int the encoded end of character positions in the source file, exclusive

characterRangeEnd

back to summary

public int characterRangeEnd()

Returns the encoded end of character positions in the source file, exclusive.

Returns:int: the encoded end of character positions in the source file, exclusive

characterRangeStart	back to summary
public int characterRangeStart() Returns the encoded start of character positions in the source file, inclusive. Returns:int the encoded start of character positions in the source file, inclusive

characterRangeStart

back to summary

public int characterRangeStart()

Returns the encoded start of character positions in the source file, inclusive.

Returns:int: the encoded start of character positions in the source file, inclusive

endPc back to summary

endPc	back to summary
public int endPc() Returns the end of indices in the code array, exclusive. Returns:int the end of indices in the code array, exclusive See Also `CharacterRange#endScope()`

public int endPc()

Returns the end of indices in the code array, exclusive.

Returns:int: the end of indices in the code array, exclusive
See Also: CharacterRange#endScope()

flags back to summary

flags	back to summary
public int flags() Returns the flags of this character range entry. The value of the flags item describes the kind of range. Multiple flags may be set within flags. `CharacterRange#FLAG_STATEMENT` Range is a Statement (except ExpressionStatement), StatementExpression (JLS 14.8), as well as each `VariableDeclaratorId = VariableInitializer` of LocalVariableDeclarationStatement (JLS 14.4) or FieldDeclaration (JLS 8.3) in the grammar. `CharacterRange#FLAG_BLOCK` Range is a Block in the grammar. `CharacterRange#FLAG_ASSIGNMENT` Range is an assignment expression - `Expression1 AssignmentOperator Expression1` in the grammar as well as increment and decrement expressions (both prefix and postfix). `CharacterRange#FLAG_FLOW_CONTROLLER` An expression whose value will affect control flow. `Flowcon` in the following: if ( Flowcon ) Statement [else Statement] for ( ForInitOpt ; [Flowcon] ; ForUpdateOpt ) Statement while ( Flowcon ) Statement do Statement while ( Flowcon ) ; switch ( Flowcon ) { SwitchBlockStatementGroups } Flowcon \|\| Expression3 Flowcon && Expression3 Flowcon ? Expression : Expression1 `CharacterRange#FLAG_FLOW_TARGET` Statement or expression effected by a CRT_FLOW_CONTROLLER. `Flowtarg` in the following: if ( Flowcon ) Flowtarg [else Flowtarg] for ( ForInitOpt ; [Flowcon] ; ForUpdateOpt ) Flowtarg while ( Flowcon ) Flowtarg do Flowtarg while ( Flowcon ) ; Flowcon \|\| Flowtarg Flowcon && Flowtarg Flowcon ? Flowtarg : Flowtarg `CharacterRange#FLAG_INVOKE` Method invocation. For example: Identifier Arguments. `CharacterRange#FLAG_CREATE` New object creation. For example: new Creator. `CharacterRange#FLAG_BRANCH_TRUE` A condition encoded in the branch instruction immediately contained in the code range for this item is not inverted towards the corresponding branch condition in the source code. I.e. actual jump occurs if and only if the source code branch condition evaluates to true. Entries of this type are produced only for conditions that are listed in the description of CRT_FLOW_CONTROLLER flag. The source range for the entry contains flow controlling expression. start_pc field for an entry of this type must point to a branch instruction: if_acmp<cond>, if_icmp<cond>, if<cond>, ifnonull, ifnull or goto. CRT_BRANCH_TRUE and CRT_BRANCH_FALSE are special kinds of entries that can be used to determine what branch of a condition was chosen during the runtime. `CharacterRange#FLAG_BRANCH_FALSE` A condition encoded in the branch instruction immediately contained in the code range for this item is inverted towards the corresponding branch condition in the source code. I.e. actual jump occurs if and only if the source code branch condition evaluates to false. Entries of this type are produced only for conditions that are listed in the description of CRT_FLOW_CONTROLLER flag. The source range for the entry contains flow controlling expression. start_pc field for an entry of this type must point to a branch instruction: if_acmp<cond>, if_icmp<cond>, if<cond>, ifnonull, ifnull or goto. All bits of the flags item not assigned above are reserved for future use. They should be set to zero in generated class files and should be ignored by Java virtual machine implementations. Returns:int the flags of this character range entry See Also `CharacterRange#flags()`

public int flags()

Returns the flags of this character range entry.

The value of the flags item describes the kind of range. Multiple flags may be set within flags.

CharacterRange#FLAG_STATEMENT Range is a Statement (except ExpressionStatement), StatementExpression (JLS 14.8), as well as each VariableDeclaratorId = VariableInitializer of LocalVariableDeclarationStatement (JLS 14.4) or FieldDeclaration (JLS 8.3) in the grammar.
CharacterRange#FLAG_BLOCK Range is a Block in the grammar.
CharacterRange#FLAG_ASSIGNMENT Range is an assignment expression - Expression1 AssignmentOperator Expression1 in the grammar as well as increment and decrement expressions (both prefix and postfix).

CharacterRange#FLAG_FLOW_CONTROLLER An expression whose value will affect control flow. Flowcon in the following:

if ( Flowcon ) Statement [else Statement]
for ( ForInitOpt ; [Flowcon] ; ForUpdateOpt ) Statement
while ( Flowcon ) Statement
do Statement while ( Flowcon ) ;
switch ( Flowcon ) { SwitchBlockStatementGroups }
Flowcon || Expression3
Flowcon && Expression3
Flowcon ? Expression : Expression1

CharacterRange#FLAG_FLOW_TARGET Statement or expression effected by a CRT_FLOW_CONTROLLER. Flowtarg in the following:

if ( Flowcon ) Flowtarg [else Flowtarg]
for ( ForInitOpt ; [Flowcon] ; ForUpdateOpt ) Flowtarg
while ( Flowcon ) Flowtarg
do Flowtarg while ( Flowcon ) ;
Flowcon || Flowtarg
Flowcon && Flowtarg
Flowcon ? Flowtarg : Flowtarg

CharacterRange#FLAG_INVOKE Method invocation. For example: Identifier Arguments.
CharacterRange#FLAG_CREATE New object creation. For example: new Creator.
CharacterRange#FLAG_BRANCH_TRUE A condition encoded in the branch instruction immediately contained in the code range for this item is not inverted towards the corresponding branch condition in the source code. I.e. actual jump occurs if and only if the source code branch condition evaluates to true. Entries of this type are produced only for conditions that are listed in the description of CRT_FLOW_CONTROLLER flag. The source range for the entry contains flow controlling expression. start_pc field for an entry of this type must point to a branch instruction: if_acmp<cond>, if_icmp<cond>, if<cond>, ifnonull, ifnull or goto. CRT_BRANCH_TRUE and CRT_BRANCH_FALSE are special kinds of entries that can be used to determine what branch of a condition was chosen during the runtime.
CharacterRange#FLAG_BRANCH_FALSE A condition encoded in the branch instruction immediately contained in the code range for this item is inverted towards the corresponding branch condition in the source code. I.e. actual jump occurs if and only if the source code branch condition evaluates to false. Entries of this type are produced only for conditions that are listed in the description of CRT_FLOW_CONTROLLER flag. The source range for the entry contains flow controlling expression. start_pc field for an entry of this type must point to a branch instruction: if_acmp<cond>, if_icmp<cond>, if<cond>, ifnonull, ifnull or goto.

All bits of the flags item not assigned above are reserved for future use. They should be set to zero in generated class files and should be ignored by Java virtual machine implementations.

Returns:int: the flags of this character range entry
See Also: CharacterRange#flags()

of back to summary

of	back to summary
public static CharacterRangeInfo of(int startPc, int endPc, int characterRangeStart, int characterRangeEnd, int flags) Returns a character range entry. API Note The created entry cannot be written to a `CodeBuilder`. Use `CodeBuilder::characterRange` instead. Parameters startPc:int the start of indices in the code array, inclusive endPc:int the end of indices in the code array, exclusive characterRangeStart:int the encoded start of character positions in the source file, inclusive characterRangeEnd:int the encoded end of character positions in the source file, exclusive flags:int the flags of this entry Returns:CharacterRangeInfo a character range entry Exceptions IllegalArgumentException: if `startPc`, `endPc`, or `flags` is not `u2`

public static CharacterRangeInfo of(int startPc, int endPc, int characterRangeStart, int characterRangeEnd, int flags)

Returns a character range entry.

API Note

The created entry cannot be written to a CodeBuilder. Use CodeBuilder::characterRange instead.

Parameters

startPc:int: the start of indices in the code array, inclusive
endPc:int: the end of indices in the code array, exclusive
characterRangeStart:int: the encoded start of character positions in the source file, inclusive
characterRangeEnd:int: the encoded end of character positions in the source file, exclusive
flags:int: the flags of this entry

Returns:CharacterRangeInfo

a character range entry

Exceptions

IllegalArgumentException:: if startPc, endPc, or flags is not u2

startPc back to summary

startPc	back to summary
public int startPc() Returns the start of indices in the code array, inclusive. Returns:int the start of indices in the code array, inclusive See Also `CharacterRange#startScope()`

public int startPc()

Returns the start of indices in the code array, inclusive.

Returns:int: the start of indices in the code array, inclusive
See Also: CharacterRange#startScope()

public sealed Interface CharacterRangeInfo

Method Summary

Method Detail