OffsetMap (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInsight.completion.OffsetMap

All Implemented Interfaces:: Disposable

public class OffsetMap
extends java.lang.Object
implements Disposable

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable
  Disposable.Parent

Constructor Summary

Constructors
Constructor and Description

OffsetMap(Document document)

Constructors
Constructor and Description
`OffsetMap(Document document)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOffset(OffsetKey key, int offset)` Register key-offset binding.
`boolean`	`containsOffset(OffsetKey key)`
`OffsetMap`	`copyOffsets(Document anotherDocument)`
`void`	`dispose()` Usually not invoked directly, see class javadoc.
`java.util.List<OffsetKey>`	`getAllOffsets()`
`Document`	`getDocument()`
`int`	`getOffset(OffsetKey key)`
`OffsetMap`	`mapOffsets(Document anotherDocument, java.util.function.Function<java.lang.Integer,java.lang.Integer> mapping)`
`void`	`removeOffset(OffsetKey key)`
`java.lang.String`	`toString()`
`boolean`	`wasModified(OffsetKey key)`

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

- Constructor Detail
  - OffsetMap
```
public OffsetMap(Document document)
```
- Method Detail
  - getOffset
```
public int getOffset(OffsetKey key)
```
    Parameters:
    
    key - key
    
    Returns:
    
    offset An offset registered earlier with this key. -1 if offset wasn't registered or became invalidated due to document changes
  - containsOffset
```
public boolean containsOffset(OffsetKey key)
```
  - addOffset
```
public void addOffset(OffsetKey key,
                      int offset)
```
    Register key-offset binding. Offset will change together with Document editing operations unless an operation replaces completely the offset vicinity.
    
    Parameters:
    
    key - offset key
    
    offset - offset in the document
  - removeOffset
```
public void removeOffset(OffsetKey key)
```
  - getAllOffsets
```
public java.util.List<OffsetKey> getAllOffsets()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - wasModified
```
public boolean wasModified(OffsetKey key)
```
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Usually not invoked directly, see class javadoc.
    
    Specified by:
    
    dispose in interface Disposable
  - getDocument
```
public Document getDocument()
```
  - copyOffsets
```
public OffsetMap copyOffsets(Document anotherDocument)
```
  - mapOffsets
```
public OffsetMap mapOffsets(Document anotherDocument,
                            java.util.function.Function<java.lang.Integer,java.lang.Integer> mapping)
```

Class OffsetMap

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OffsetMap

Method Detail

getOffset

containsOffset

addOffset

removeOffset

getAllOffsets

toString

wasModified

dispose

getDocument

copyOffsets

mapOffsets