OpenJDK 27 · java.lang.classfile.instruction.CharacterRange

A pseudo-instruction which models a single entry in the CharacterRangeTable attribute. Delivered as a CodeElement during traversal of the elements of a CodeModel, according to the setting of the ClassFile.DebugElementsOption option.

A character range entry is composite:

CharacterRange(
    Label startScope,
    Label endScope,
    int characterRangeStart,
    int characterRangeEnd,
    int flags
)

Another model, CharacterRangeInfo, also models a character range entry; it has no dependency on a CodeModel and represents of bci values as ints instead of Labels, and is used as components of a CharacterRangeTableAttribute.

Field Summary

Modifier and Type	Field and Description
public static final int	FLAG_ASSIGNMENT The bit mask of ASSIGNMENT `CharacterRangeInfo` kind.
public static final int	FLAG_BLOCK The bit mask of BLOCK `CharacterRangeInfo` kind.
public static final int	FLAG_BRANCH_FALSE The bit mask of BRANCH_FALSE `CharacterRangeInfo` kind.
public static final int	FLAG_BRANCH_TRUE The bit mask of BRANCH_TRUE `CharacterRangeInfo` kind.
public static final int	FLAG_CREATE The bit mask of CREATE `CharacterRangeInfo` kind.
public static final int	FLAG_FLOW_CONTROLLER The bit mask of FLOW_CONTROLLER `CharacterRangeInfo` kind.
public static final int	FLAG_FLOW_TARGET The bit mask of FLOW_TARGET `CharacterRangeInfo` kind.
public static final int	FLAG_INVOKE The bit mask of INVOKE `CharacterRangeInfo` kind.
public static final int	FLAG_STATEMENT The bit mask of STATEMENT `CharacterRangeInfo` kind.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the encoded end of the character range region (exclusive) characterRangeEnd() Returns the encoded end of the character range region (exclusive).
public int	Returns: the encoded start of the character range region (inclusive) characterRangeStart() Returns the encoded start of the character range region (inclusive).
public Label	Returns: the end of the instruction range endScope() Returns the end of the instruction range.
public int	Returns: the flags flags() A flags word, indicating the kind of range.
public static CharacterRange	Returns: a character range pseudo-instruction of(Label the start of the instruction range startScope, Label the end of the instruction range endScope, int the encoded start of the character range region (inclusive) characterRangeStart, int the encoded end of the character range region (exclusive) characterRangeEnd, int a flags word, indicating the kind of range flags) Returns a character range pseudo-instruction.
public Label	Returns: the start of the instruction range startScope() Returns the start of the instruction range.

Field Detail

FLAG_ASSIGNMENT	back to summary
public static final int FLAG_ASSIGNMENT The bit mask of ASSIGNMENT `CharacterRangeInfo` kind.

FLAG_BLOCK	back to summary
public static final int FLAG_BLOCK The bit mask of BLOCK `CharacterRangeInfo` kind.

FLAG_BRANCH_FALSE	back to summary
public static final int FLAG_BRANCH_FALSE The bit mask of BRANCH_FALSE `CharacterRangeInfo` kind.

FLAG_BRANCH_TRUE	back to summary
public static final int FLAG_BRANCH_TRUE The bit mask of BRANCH_TRUE `CharacterRangeInfo` kind.

FLAG_CREATE	back to summary
public static final int FLAG_CREATE The bit mask of CREATE `CharacterRangeInfo` kind.

FLAG_FLOW_CONTROLLER	back to summary
public static final int FLAG_FLOW_CONTROLLER The bit mask of FLOW_CONTROLLER `CharacterRangeInfo` kind.

FLAG_FLOW_TARGET	back to summary
public static final int FLAG_FLOW_TARGET The bit mask of FLOW_TARGET `CharacterRangeInfo` kind.

FLAG_INVOKE	back to summary
public static final int FLAG_INVOKE The bit mask of INVOKE `CharacterRangeInfo` kind.

FLAG_STATEMENT	back to summary
public static final int FLAG_STATEMENT The bit mask of STATEMENT `CharacterRangeInfo` kind.

Method Detail

characterRangeEnd back to summary

characterRangeEnd	back to summary
public int characterRangeEnd() Returns the encoded end of the character range region (exclusive). . The value is constructed from the line_number/column_number pair as given by `line_number << 10 + column_number`, where the source file is viewed as an array of (possibly multi-byte) characters. Returns:int the encoded end of the character range region (exclusive)

public int characterRangeEnd()

Returns the encoded end of the character range region (exclusive). . The value is constructed from the line_number/column_number pair as given by line_number << 10 + column_number, where the source file is viewed as an array of (possibly multi-byte) characters.

Returns:int: the encoded end of the character range region (exclusive)

characterRangeStart back to summary

characterRangeStart	back to summary
public int characterRangeStart() Returns the encoded start of the character range region (inclusive). The value is constructed from the line_number/column_number pair as given by `line_number << 10 + column_number`, where the source file is viewed as an array of (possibly multi-byte) characters. Returns:int the encoded start of the character range region (inclusive)

public int characterRangeStart()

Returns the encoded start of the character range region (inclusive). The value is constructed from the line_number/column_number pair as given by line_number << 10 + column_number, where the source file is viewed as an array of (possibly multi-byte) characters.

Returns:int: the encoded start of the character range region (inclusive)

endScope	back to summary
public Label endScope() Returns the end of the instruction range. Returns:Label the end of the instruction range

endScope

back to summary

public Label endScope()

Returns the end of the instruction range.

Returns:Label: the end of the instruction range

flags back to summary

flags	back to summary
public int flags() A flags word, indicating the kind of range. Multiple flag bits may be set. Valid flags include: `FLAG_STATEMENT` `FLAG_BLOCK` `FLAG_ASSIGNMENT` `FLAG_FLOW_CONTROLLER` `FLAG_FLOW_TARGET` `FLAG_INVOKE` `FLAG_CREATE` `FLAG_BRANCH_TRUE` `FLAG_BRANCH_FALSE` Returns:int the flags See Also `CharacterRangeInfo#flags()`

public int flags()

A flags word, indicating the kind of range. Multiple flag bits may be set. Valid flags include:

Returns:int: the flags
See Also: CharacterRangeInfo#flags()

of back to summary

of	back to summary
public static CharacterRange of(Label startScope, Label endScope, int characterRangeStart, int characterRangeEnd, int flags) Returns a character range pseudo-instruction. Parameters startScope:Label the start of the instruction range endScope:Label the end of the instruction range characterRangeStart:int the encoded start of the character range region (inclusive) characterRangeEnd:int the encoded end of the character range region (exclusive) flags:int a flags word, indicating the kind of range Returns:CharacterRange a character range pseudo-instruction Exceptions IllegalArgumentException: if `flags` is not `u2`

public static CharacterRange of(Label startScope, Label endScope, int characterRangeStart, int characterRangeEnd, int flags)

Returns a character range pseudo-instruction.

Parameters

startScope:Label: the start of the instruction range
endScope:Label: the end of the instruction range
characterRangeStart:int: the encoded start of the character range region (inclusive)
characterRangeEnd:int: the encoded end of the character range region (exclusive)
flags:int: a flags word, indicating the kind of range

Returns:CharacterRange

a character range pseudo-instruction

Exceptions

IllegalArgumentException:: if flags is not u2

startScope	back to summary
public Label startScope() Returns the start of the instruction range. Returns:Label the start of the instruction range

startScope

back to summary

public Label startScope()

Returns the start of the instruction range.

Returns:Label: the start of the instruction range

public sealed Interface CharacterRange

Field Summary

Method Summary

Field Detail

Method Detail