ConstantFieldRefInfo (org.macroing.cel4j.java.binary API)

java.lang.Object
- org.macroing.cel4j.java.binary.classfile.CPInfo
- - org.macroing.cel4j.java.binary.classfile.cpinfo.ConstantFieldRefInfo

All Implemented Interfaces:

Node
```
public final class ConstantFieldRefInfo
extends CPInfo
```
A ConstantFieldRefInfo denotes a CONSTANT_Fieldref_info structure in the constant_pool of a ClassFile structure.
The CONSTANT_Fieldref_info structure was added to Java in version 1.0.2.
This class is not thread-safe.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String NAME
The name of the CONSTANT_Fieldref_info structure.

static int TAG
The tag for CONSTANT_Fieldref.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`NAME` The name of the CONSTANT_Fieldref_info structure.
`static int`	`TAG` The tag for CONSTANT_Fieldref.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConstantFieldRefInfo`	`copy()` Returns a copy of this `ConstantFieldRefInfo` instance.
`boolean`	`equals(java.lang.Object object)` Returns `true` if, and only if, `object` is an instance of `ConstantFieldRefInfo`, and that `ConstantFieldRefInfo` instance is equal to this `ConstantFieldRefInfo` instance, `false` otherwise.
`static java.util.List<ConstantFieldRefInfo>`	`filter(Node node)` Returns a `List` with all `ConstantFieldRefInfo`s.
`int`	`getClassIndex()` Returns the class_index of this `ConstantFieldRefInfo` instance.
`int`	`getNameAndTypeIndex()` Returns the name_and_type_index of this `ConstantFieldRefInfo` instance.
`int`	`hashCode()` Returns a hash code for this `ConstantFieldRefInfo` instance.
`static ConstantFieldRefInfo`	`newInstance(int classIndex, int nameAndTypeIndex)` Returns a new `ConstantFieldRefInfo`.
`void`	`setClassIndex(int classIndex)` Sets a new class_index for this `ConstantFieldRefInfo` instance.
`void`	`setNameAndTypeIndex(int nameAndTypeIndex)` Sets a new name_and_type_index for this `ConstantFieldRefInfo` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `ConstantFieldRefInfo` instance.
`void`	`write(java.io.DataOutput dataOutput)` Writes this `ConstantFieldRefInfo` to `dataOutput`.
`void`	`write(Document document)` Writes this `ConstantFieldRefInfo` to `document`.

Methods inherited from class org.macroing.cel4j.java.binary.classfile.CPInfo
getConstantPoolEntryCount, getName, getTag

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

Methods inherited from interface org.macroing.cel4j.java.binary.node.Node
accept, accept

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    The name of the CONSTANT_Fieldref_info structure.
    
    See Also:
    
    Constant Field Values
  - TAG
```
public static final int TAG
```
    The tag for CONSTANT_Fieldref.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - copy
```
public ConstantFieldRefInfo copy()
```
    Returns a copy of this ConstantFieldRefInfo instance.
    
    Specified by:
    
    copy in class CPInfo
    
    Returns:
    
    a copy of this ConstantFieldRefInfo instance
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this ConstantFieldRefInfo instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this ConstantFieldRefInfo instance
  - equals
```
public boolean equals(java.lang.Object object)
```
    Returns true if, and only if, object is an instance of ConstantFieldRefInfo, and that ConstantFieldRefInfo instance is equal to this ConstantFieldRefInfo instance, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - an Object to compare to this ConstantFieldRefInfo instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of ConstantFieldRefInfo, and that ConstantFieldRefInfo instance is equal to this ConstantFieldRefInfo instance, false otherwise
  - getClassIndex
```
public int getClassIndex()
```
    Returns the class_index of this ConstantFieldRefInfo instance.
    
    Returns:
    
    the class_index of this ConstantFieldRefInfo instance
  - getNameAndTypeIndex
```
public int getNameAndTypeIndex()
```
    Returns the name_and_type_index of this ConstantFieldRefInfo instance.
    
    Returns:
    
    the name_and_type_index of this ConstantFieldRefInfo instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this ConstantFieldRefInfo instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this ConstantFieldRefInfo instance
  - setClassIndex
```
public void setClassIndex(int classIndex)
```
    Sets a new class_index for this ConstantFieldRefInfo instance.
    If classIndex is less than or equal to 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    classIndex - the new class_index for this ConstantFieldRefInfo instance
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, classIndex is less than or equal to 0
  - setNameAndTypeIndex
```
public void setNameAndTypeIndex(int nameAndTypeIndex)
```
    Sets a new name_and_type_index for this ConstantFieldRefInfo instance.
    If nameAndTypeIndex is less than or equal to 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    nameAndTypeIndex - the new name_and_type_index for this ConstantFieldRefInfo instance
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, nameAndTypeIndex is less than or equal to 0
  - write
```
public void write(java.io.DataOutput dataOutput)
```
    Writes this ConstantFieldRefInfo to dataOutput.
    If dataOutput is an OutputStream (or any other type of stream), this method will not close it.
    If dataOutput is null, a NullPointerException will be thrown.
    If an I/O-error occurs, an UncheckedIOException will be thrown.
    
    Specified by:
    
    write in class CPInfo
    
    Parameters:
    
    dataOutput - the DataOutput to write to
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, dataOutput is null
    
    java.io.UncheckedIOException - thrown if, and only if, an I/O-error occurs
  - write
```
public void write(Document document)
```
    Writes this ConstantFieldRefInfo to document.
    If document is null, a NullPointerException may be thrown. But no guarantees can be made.
    
    Specified by:
    
    write in class CPInfo
    
    Parameters:
    
    document - the Document to write to
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, document is null
  - newInstance
```
public static ConstantFieldRefInfo newInstance(int classIndex,
                                               int nameAndTypeIndex)
```
    Returns a new ConstantFieldRefInfo.
    If either classIndex or nameAndTypeIndex are less than or equal to 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    classIndex - the class_index for the new ConstantFieldRefInfo instance
    
    nameAndTypeIndex - the name_and_type_index for the new ConstantFieldRefInfo instance
    
    Returns:
    
    a new ConstantFieldRefInfo
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, either classIndex or nameAndTypeIndex are less than or equal to 0
  - filter
```
public static java.util.List<ConstantFieldRefInfo> filter(Node node)
```
    Returns a List with all ConstantFieldRefInfos.
    All ConstantFieldRefInfos are found by traversing node using a simple NodeHierarchicalVisitor implementation.
    If node is null, a NullPointerException will be thrown.
    
    Parameters:
    
    node - the Node to start traversal from
    
    Returns:
    
    a List with all ConstantFieldRefInfos
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, node is null

Class ConstantFieldRefInfo

Field Summary

Method Summary

Methods inherited from class org.macroing.cel4j.java.binary.classfile.CPInfo

Methods inherited from class java.lang.Object

Methods inherited from interface org.macroing.cel4j.java.binary.node.Node

Field Detail

NAME

TAG

Method Detail

copy

toString

equals

getClassIndex

getNameAndTypeIndex

hashCode

setClassIndex

setNameAndTypeIndex

write

write

newInstance

filter