LocalReference (golo 3.3.0 API)

java.lang.Object
- gololang.ir.GoloElement<LocalReference>
- - gololang.ir.LocalReference

```
public final class LocalReference
extends GoloElement<LocalReference>
```
Represents a reference.
A reference is ether a variable (as defined by var answer = 42) or a constant (as defined by let answer = 42).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LocalReference.Kind

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocalReference.Kind`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(GoloIrVisitor visitor)` Accept the visitor.
`static LocalReference`	`create(java.lang.Object name, LocalReference.Kind kind)`
`boolean`	`equals(java.lang.Object o)`
`static LocalReference`	`generate()` Creates a new local reference with a generated unique name.
`int`	`getIndex()` Internal API
`LocalReference.Kind`	`getKind()`
`java.lang.String`	`getName()`
`int`	`hashCode()`
`LocalReference`	`index(int index)`
`boolean`	`isConstant()`
`boolean`	`isModuleState()`
`boolean`	`isSynthetic()`
`LocalReference`	`kind(LocalReference.Kind k)`
`ReferenceLookup`	`lookup()` Returns a `ReferenceLookup` referencing this variable.
`LocalReference`	`moduleLevel()`
`static LocalReference`	`of(java.lang.Object name)` Creates a local reference.
`protected void`	`replaceElement(GoloElement<?> original, GoloElement<?> newElement)` Replace a child.
`protected LocalReference`	`self()`
`void`	`setIndex(int index)` Internal API
`LocalReference`	`synthetic()`
`LocalReference`	`synthetic(boolean isSynthetic)`
`java.lang.String`	`toString()`
`LocalReference`	`variable()`

Methods inherited from class gololang.ir.GoloElement
ancestor, ancestor, ancestorOfType, cantConvert, cantReplace, cantReplace, children, children, children, descendants, descendants, descendants, documentation, documentation, doesNotContain, enclosingModule, getLocalReferenceTable, hasParent, hasPosition, makeParentOf, metadata, metadata, next, next, next, ofAST, parent, positionInSourceCode, positionInSourceCode, previous, previous, previous, replaceInParentBy, walk

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

- Method Detail
  - of
```
public static LocalReference of(java.lang.Object name)
```
    Creates a local reference.
    If the argument is already a local reference, it is returned unchanged, otherwise, its string representation is used to name the reference.
    
    Parameters:
    
    name - the name of the reference
    
    Returns:
    
    a local reference to the variable named after the argument
  - generate
```
public static LocalReference generate()
```
    Creates a new local reference with a generated unique name.
  - create
```
public static LocalReference create(java.lang.Object name,
                                    LocalReference.Kind kind)
```
  - self
```
protected LocalReference self()
```
    Specified by:
    
    self in class GoloElement<LocalReference>
  - getKind
```
public LocalReference.Kind getKind()
```
  - variable
```
public LocalReference variable()
```
  - moduleLevel
```
public LocalReference moduleLevel()
```
  - kind
```
public LocalReference kind(LocalReference.Kind k)
```
  - getName
```
public java.lang.String getName()
```
  - synthetic
```
public LocalReference synthetic(boolean isSynthetic)
```
  - synthetic
```
public LocalReference synthetic()
```
  - isSynthetic
```
public boolean isSynthetic()
```
  - isModuleState
```
public boolean isModuleState()
```
  - isConstant
```
public boolean isConstant()
```
  - getIndex
```
public int getIndex()
```
    Internal API
  - setIndex
```
public void setIndex(int index)
```
    Internal API
  - index
```
public LocalReference index(int index)
```
  - lookup
```
public ReferenceLookup lookup()
```
    Returns a ReferenceLookup referencing this variable.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - accept
```
public void accept(GoloIrVisitor visitor)
```
    Accept the visitor.
    This method should only call the visitor visitXXXX method. The children of this node will be visited by the GoloElement.walk(GoloIrVisitor) method.
    
    Specified by:
    
    accept in class GoloElement<LocalReference>
  - replaceElement
```
protected void replaceElement(GoloElement<?> original,
                              GoloElement<?> newElement)
```
    Replace a child.
    Replace original with newElement if original is a child of this node and type matches.
    
    Specified by:
    
    replaceElement in class GoloElement<LocalReference>
    
    Parameters:
    
    original - the original value to replace. Must be a child of this node
    
    newElement - the element to replace with. Type must match.
    
    See Also:
    
    GoloElement.cantReplace(), GoloElement.cantReplace(GoloElement, GoloElement), GoloElement.doesNotContain(GoloElement), GoloElement.cantConvert(String, Object)

Class LocalReference

Nested Class Summary

Method Summary

Methods inherited from class gololang.ir.GoloElement

Methods inherited from class java.lang.Object

Method Detail

of

generate

create

self

getKind

variable

moduleLevel

kind

getName

synthetic

synthetic

isSynthetic

isModuleState

isConstant

getIndex

setIndex

index

lookup

toString

equals

hashCode

accept

replaceElement