GroupBoundaries

java.lang.Object
- com.oracle.truffle.regex.tregex.parser.ast.GroupBoundaries

All Implemented Interfaces:

JsonConvertible
```
public class GroupBoundaries
extends Object
implements JsonConvertible
```
Objects of this class represent the capture group boundaries traversed in a single NFAStateTransition or ASTTransition. The boundaries of one capture group correspond to its opening and closing brackets. All capture group boundaries are mapped to indices according to Group.getBoundaryIndexStart() and Group.getBoundaryIndexEnd(). A transition may update or clear any boundary when traversed.
To save space, instances of this class are deduplicated in RegexAST. Due to the deduplication, every instance must be treated as immutable!

See Also:

ASTTransition, NFAStateTransition, RegexAST

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(int[] array, int offset, int index)`
`void`	`applyToResultFactory(PreCalculatedResultFactory resultFactory, int index)` Updates a resultFactory in respect to a single transition and index.
`byte[]`	`clearsToPartialTransitionArray(int targetArray)` Creates a byte array suitable to be part of the `indexClears` parameter passed to `DFACaptureGroupPartialTransition.create(DFAGenerator, byte[], byte[], byte[][], byte[][], byte)` from this object.
`boolean`	`equals(Object obj)`
`CompilationFinalBitSet`	`getClearIndices()` Directly returns the `CompilationFinalBitSet` used to store the indices of all capture group boundaries that should be cleared when traversed.
`byte[]`	`getClearIndicesArray()`
`static GroupBoundaries`	`getEmptyInstance()`
`CompilationFinalBitSet`	`getUpdateIndices()` Directly returns the `CompilationFinalBitSet` used to store the indices of all capture group boundaries that should be updated when traversed.
`byte[]`	`getUpdateIndicesArray()`
`int`	`hashCode()`
`boolean`	`hasIndexClears()`
`boolean`	`hasIndexUpdates()`
`boolean`	`isEmpty()`
`void`	`materializeArrays()`
`JsonValue`	`toJson()`
`String`	`toString()`
`void`	`updateBitSets(CompilationFinalBitSet foreignUpdateIndices, CompilationFinalBitSet foreignClearIndices)` Updates the given `CompilationFinalBitSet`s with the values contained in this `GroupBoundaries` object.
`byte[]`	`updatesToPartialTransitionArray(int targetArray)` Creates a byte array suitable to be part of the `indexUpdates` parameter passed to `DFACaptureGroupPartialTransition.create(DFAGenerator, byte[], byte[], byte[][], byte[][], byte)` from this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getEmptyInstance
```
public static GroupBoundaries getEmptyInstance()
```
  - isEmpty
```
public boolean isEmpty()
```
  - updatesToPartialTransitionArray
```
public byte[] updatesToPartialTransitionArray(int targetArray)
```
    Creates a byte array suitable to be part of the indexUpdates parameter passed to DFACaptureGroupPartialTransition.create(DFAGenerator, byte[], byte[], byte[][], byte[][], byte) from this object.
    
    Parameters:
    
    targetArray - the index of the row to be targeted.
    
    See Also:
    
    DFACaptureGroupPartialTransition.create(DFAGenerator, byte[], byte[], byte[][], byte[][], byte)
  - clearsToPartialTransitionArray
```
public byte[] clearsToPartialTransitionArray(int targetArray)
```
    Creates a byte array suitable to be part of the indexClears parameter passed to DFACaptureGroupPartialTransition.create(DFAGenerator, byte[], byte[], byte[][], byte[][], byte) from this object.
    
    Parameters:
    
    targetArray - the index of the row to be targeted.
    
    See Also:
    
    DFACaptureGroupPartialTransition.create(DFAGenerator, byte[], byte[], byte[][], byte[][], byte)
  - materializeArrays
```
public void materializeArrays()
```
  - getUpdateIndices
```
public CompilationFinalBitSet getUpdateIndices()
```
    Directly returns the CompilationFinalBitSet used to store the indices of all capture group boundaries that should be updated when traversed.
    CAUTION: Do not alter the returned object!
  - getClearIndices
```
public CompilationFinalBitSet getClearIndices()
```
    Directly returns the CompilationFinalBitSet used to store the indices of all capture group boundaries that should be cleared when traversed.
    CAUTION: Do not alter the returned object!
  - getUpdateIndicesArray
```
public byte[] getUpdateIndicesArray()
```
  - getClearIndicesArray
```
public byte[] getClearIndicesArray()
```
  - hasIndexUpdates
```
public boolean hasIndexUpdates()
```
  - hasIndexClears
```
public boolean hasIndexClears()
```
  - updateBitSets
```
public void updateBitSets(CompilationFinalBitSet foreignUpdateIndices,
                          CompilationFinalBitSet foreignClearIndices)
```
    Updates the given CompilationFinalBitSets with the values contained in this GroupBoundaries object.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - applyToResultFactory
```
public void applyToResultFactory(PreCalculatedResultFactory resultFactory,
                                 int index)
```
    Updates a resultFactory in respect to a single transition and index.
    
    Parameters:
    
    resultFactory - the resultFactory to update.
    
    index - current index. All group boundaries contained in this object will be set to this value in the resultFactory.
  - apply
```
public void apply(int[] array,
                  int offset,
                  int index)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJson
```
public JsonValue toJson()
```
    Specified by:
    
    toJson in interface JsonConvertible

Class GroupBoundaries

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getEmptyInstance

isEmpty

updatesToPartialTransitionArray

clearsToPartialTransitionArray

materializeArrays

getUpdateIndices

getClearIndices

getUpdateIndicesArray

getClearIndicesArray

hasIndexUpdates

hasIndexClears

updateBitSets

equals

hashCode

applyToResultFactory

apply

toString

toJson