NamedLocationIdentity (Graal OpenJDK Project Documentation)

java.lang.Object
- jdk.internal.jvmci.meta.LocationIdentity
- - com.oracle.graal.nodes.NamedLocationIdentity

All Implemented Interfaces:

Kind.FormatWithToString

Direct Known Subclasses:

HotSpotReplacementsUtil.HotSpotOptimizingLocationIdentity
```
public class NamedLocationIdentity
extends LocationIdentity
implements Kind.FormatWithToString
```
A LocationIdentity with a name.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class NamedLocationIdentity.DB
Map for asserting all NamedLocationIdentity instances have a unique name.

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`NamedLocationIdentity.DB` Map for asserting all `NamedLocationIdentity` instances have a unique name.

Field Summary

Fields
Modifier and Type	Field and Description
`static LocationIdentity`	`ARRAY_LENGTH_LOCATION` Denotes the location of the length field of a Java array.
`private static EnumMap<Kind,LocationIdentity>`	`ARRAY_LOCATIONS`
`static LocationIdentity`	`FINAL_LOCATION` Denotes the location of a value that is guaranteed to be unchanging.
`private boolean`	`immutable`
`private String`	`name`

Fields inherited from class jdk.internal.jvmci.meta.LocationIdentity
ANY_LOCATION

Constructor Summary

Constructors
Modifier Constructor and Description

protected NamedLocationIdentity(String name, boolean immutable)

Constructors
Modifier	Constructor and Description
`protected`	`NamedLocationIdentity(String name, boolean immutable)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LocationIdentity`	`any()`
`private static NamedLocationIdentity`	`create(String name, boolean immutable)` Creates a named unique location identity for read and write operations.
`static LocationIdentity`	`getArrayLocation(Kind elementKind)` Returns the named location identity for an array of the given element kind.
`static NamedLocationIdentity`	`immutable(String name)` Creates a named unique location identity for read operations against immutable memory.
`private static EnumMap<Kind,LocationIdentity>`	`initArrayLocations()`
`boolean`	`isImmutable()` Denotes a location is unchanging in all cases.
`static NamedLocationIdentity`	`mutable(String name)` Creates a named unique location identity for read and write operations against mutable memory.
`String`	`toString()`

Methods inherited from class jdk.internal.jvmci.meta.LocationIdentity
isAny, isMutable, isSingle, overlaps

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

- Field Detail
  - FINAL_LOCATION
```
public static final LocationIdentity FINAL_LOCATION
```
    Denotes the location of a value that is guaranteed to be unchanging.
  - ARRAY_LENGTH_LOCATION
```
public static final LocationIdentity ARRAY_LENGTH_LOCATION
```
    Denotes the location of the length field of a Java array.
  - name
```
private final String name
```
  - immutable
```
private final boolean immutable
```
  - ARRAY_LOCATIONS
```
private static final EnumMap<Kind,LocationIdentity> ARRAY_LOCATIONS
```
- Constructor Detail
  - NamedLocationIdentity
```
protected NamedLocationIdentity(String name,
                                boolean immutable)
```
- Method Detail
  - any
```
public static LocationIdentity any()
```
  - mutable
```
public static NamedLocationIdentity mutable(String name)
```
    Creates a named unique location identity for read and write operations against mutable memory.
    
    Parameters:
    
    name - the name of the new location identity
  - immutable
```
public static NamedLocationIdentity immutable(String name)
```
    Creates a named unique location identity for read operations against immutable memory. Immutable memory will never have a visible write in the graph, which is more restictive than Java final.
    
    Parameters:
    
    name - the name of the new location identity
  - create
```
private static NamedLocationIdentity create(String name,
                                            boolean immutable)
```
    Creates a named unique location identity for read and write operations.
    
    Parameters:
    
    name - the name of the new location identity
    
    immutable - true if the location is immutable
  - isImmutable
```
public boolean isImmutable()
```
    Description copied from class: LocationIdentity
    
    Denotes a location is unchanging in all cases. Not that this is different than the Java notion of final which only requires definite assignment.
    
    Specified by:
    
    isImmutable in class LocationIdentity
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getArrayLocation
```
public static LocationIdentity getArrayLocation(Kind elementKind)
```
    Returns the named location identity for an array of the given element kind. Array accesses of the same kind must have the same location identity unless an alias analysis guarantees that two distinct arrays are accessed.
  - initArrayLocations
```
private static EnumMap<Kind,LocationIdentity> initArrayLocations()
```

Class NamedLocationIdentity

Nested Class Summary

Field Summary

Fields inherited from class jdk.internal.jvmci.meta.LocationIdentity

Constructor Summary

Method Summary

Methods inherited from class jdk.internal.jvmci.meta.LocationIdentity

Methods inherited from class java.lang.Object

Field Detail

FINAL_LOCATION

ARRAY_LENGTH_LOCATION

name

immutable

ARRAY_LOCATIONS

Constructor Detail

NamedLocationIdentity

Method Detail

any

mutable

immutable

create

isImmutable

toString

getArrayLocation

initArrayLocations