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

java.lang.Object
- org.macroing.cel4j.java.binary.classfile.AttributeInfo
- - org.macroing.cel4j.java.binary.classfile.attributeinfo.CodeAttribute

All Implemented Interfaces:

Node
```
public final class CodeAttribute
extends AttributeInfo
```
A CodeAttribute denotes a Code_attribute structure somewhere in a ClassFile structure.
This class is not thread-safe.

Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CodeAttribute.ExceptionHandler` An `ExceptionHandler` that can be found as a part of any `CodeAttribute` instances.
`static class`	`CodeAttribute.Instruction` An `Instruction` that can be found as a part of any `CodeAttribute` instances.

Field Summary

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`NAME` The name of the Code_attribute structure.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(NodeHierarchicalVisitor nodeHierarchicalVisitor)` Accepts a `NodeHierarchicalVisitor`.
`void`	`addAttributeInfo(AttributeInfo attributeInfo)` Attempts to add `attributeInfo` to this `CodeAttribute` instance.
`void`	`addExceptionHandler(CodeAttribute.ExceptionHandler exceptionHandler)` Attempts to add `exceptionHandler` to this `CodeAttribute` instance.
`void`	`addInstruction(CodeAttribute.Instruction instruction)` Adds `instruction` to this `CodeAttribute` instance.
`boolean`	`containsAttributeInfo(AttributeInfo attributeInfo)` Returns `true` if, and only if, this `CodeAttribute` instance contains `attributeInfo`, `false` otherwise.
`CodeAttribute`	`copy()` Returns a copy of this `CodeAttribute` instance.
`boolean`	`equals(java.lang.Object object)` Returns `true` if, and only if, `object` is an instance of `CodeAttribute`, and that `CodeAttribute` instance is equal to this `CodeAttribute` instance, `false` otherwise.
`static java.util.List<CodeAttribute>`	`filter(Node node)` Returns a `List` with all `CodeAttribute`s.
`static java.util.Optional<CodeAttribute>`	`find(MethodInfo methodInfo)` Attempts to find a `CodeAttribute` instance in `methodInfo`.
`AttributeInfo`	`getAttributeInfo(AttributeInfo attributeInfo)` Returns the `AttributeInfo` instance of this `CodeAttribute` instance that is equal to `attributeInfo`.
`AttributeInfo`	`getAttributeInfo(int index)` Returns an `AttributeInfo` given its index.
`int`	`getAttributeInfoCount()` Returns the attributes_count of this `CodeAttribute` instance.
`java.util.List<AttributeInfo>`	`getAttributeInfos()` Returns a `List` with all currently added `AttributeInfo`s.
`int`	`getAttributeLength()` Returns the attribute_length of this `CodeAttribute` instance.
`int`	`getCodeLength()` Returns the code_length of this `CodeAttribute` instance.
`java.util.List<CodeAttribute.ExceptionHandler>`	`getExceptionHandlers()` Returns a `List` with all currently added `ExceptionHandler`s.
`int`	`getExceptionTableLength()` Returns the exception_table_length of this `CodeAttribute` instance.
`java.util.List<CodeAttribute.Instruction>`	`getInstructions()` Returns a `List` with all currently added `Instruction`s.
`int`	`getMaxLocals()` Returns the max_locals of this `CodeAttribute` instance.
`int`	`getMaxStack()` Returns the max_stack of this `CodeAttribute` instance.
`int`	`hashCode()` Returns a hash code for this `CodeAttribute` instance.
`static CodeAttribute`	`newInstance(int attributeNameIndex)` Returns a new `CodeAttribute` instance.
`void`	`removeAttributeInfo(AttributeInfo attributeInfo)` Attempts to remove `attributeInfo` from this `CodeAttribute` instance.
`void`	`removeExceptionHandler(CodeAttribute.ExceptionHandler exceptionHandler)` Attempts to remove `exceptionHandler` from this `CodeAttribute` instance.
`void`	`removeInstruction(CodeAttribute.Instruction instruction)` Attempts to remove `instruction` from this `CodeAttribute` instance.
`void`	`setMaxLocals(int maxLocals)` Sets a new max_locals for this `CodeAttribute` instance.
`void`	`setMaxStack(int maxStack)` Sets a new max_stack for this `CodeAttribute` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `CodeAttribute` instance.
`void`	`write(java.io.DataOutput dataOutput)` Writes this `CodeAttribute` to `dataOutput`.

Methods inherited from class org.macroing.cel4j.java.binary.classfile.AttributeInfo
getAttributeNameIndex, getName, setAttributeNameIndex

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

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    The name of the Code_attribute structure.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAttributeInfo
```
public AttributeInfo getAttributeInfo(AttributeInfo attributeInfo)
```
    Returns the AttributeInfo instance of this CodeAttribute instance that is equal to attributeInfo.
    If attributeInfo is null, a NullPointerException will be thrown.
    If this CodeAttribute instance does not contain an AttributeInfo instance that is equal to attributeInfo, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    attributeInfo - the AttributeInfo instance to test for equality against
    
    Returns:
    
    the AttributeInfo instance of this CodeAttribute instance that is equal to attributeInfo
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, this CodeAttribute instance does not contain an AttributeInfo instance that is equal to attributeInfo
    
    java.lang.NullPointerException - thrown if, and only if, attributeInfo is null
  - getAttributeInfo
```
public AttributeInfo getAttributeInfo(int index)
```
    Returns an AttributeInfo given its index.
    If index is less than 0, or greater than or equal to getAttributeInfoCount(), an IndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    index - the index of the AttributeInfo
    
    Returns:
    
    an AttributeInfo given its index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - thrown if, and only if, index is less than 0, or greater than or equal to getAttributeInfoCount()
  - copy
```
public CodeAttribute copy()
```
    Returns a copy of this CodeAttribute instance.
    
    Specified by:
    
    copy in class AttributeInfo
    
    Returns:
    
    a copy of this CodeAttribute instance
  - getAttributeInfos
```
public java.util.List<AttributeInfo> getAttributeInfos()
```
    Returns a List with all currently added AttributeInfos.
    Modifying the returned List will not affect this CodeAttribute instance.
    
    Returns:
    
    a List with all currently added AttributeInfos
  - getExceptionHandlers
```
public java.util.List<CodeAttribute.ExceptionHandler> getExceptionHandlers()
```
    Returns a List with all currently added ExceptionHandlers.
    Modifying the returned List will not affect this CodeAttribute instance.
    
    Returns:
    
    a List with all currently added ExceptionHandlers
  - getInstructions
```
public java.util.List<CodeAttribute.Instruction> getInstructions()
```
    Returns a List with all currently added Instructions.
    Modifying the returned List will not affect this CodeAttribute instance.
    
    Returns:
    
    a List with all currently added Instructions
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this CodeAttribute instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this CodeAttribute instance
  - accept
```
public boolean accept(NodeHierarchicalVisitor nodeHierarchicalVisitor)
```
    Accepts a NodeHierarchicalVisitor.
    Returns the result of nodeHierarchicalVisitor.visitLeave(this).
    If nodeHierarchicalVisitor is null, a NullPointerException will be thrown.
    If a RuntimeException is thrown by the current NodeHierarchicalVisitor, a NodeTraversalException will be thrown with the RuntimeException wrapped.
    This implementation will:
    - throw a NullPointerException if nodeHierarchicalVisitor is null.
    - throw a NodeTraversalException if nodeHierarchicalVisitor throws a RuntimeException.
    - traverse its child Nodes, if it has any.
    Parameters:
    
    nodeHierarchicalVisitor - the NodeHierarchicalVisitor to accept
    
    Returns:
    
    the result of nodeHierarchicalVisitor.visitLeave(this)
    
    Throws:
    
    NodeTraversalException - thrown if, and only if, a RuntimeException is thrown by the current NodeHierarchicalVisitor
    
    java.lang.NullPointerException - thrown if, and only if, nodeHierarchicalVisitor is null
  - containsAttributeInfo
```
public boolean containsAttributeInfo(AttributeInfo attributeInfo)
```
    Returns true if, and only if, this CodeAttribute instance contains attributeInfo, false otherwise.
    If attributeInfo is null, a NullPointerException will be thrown.
    
    Parameters:
    
    attributeInfo - the AttributeInfo to check
    
    Returns:
    
    true if, and only if, this CodeAttribute instance contains attributeInfo, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, attributeInfo is null
  - equals
```
public boolean equals(java.lang.Object object)
```
    Returns true if, and only if, object is an instance of CodeAttribute, and that CodeAttribute instance is equal to this CodeAttribute instance, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - an Object to compare to this CodeAttribute instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of CodeAttribute, and that CodeAttribute instance is equal to this CodeAttribute instance, false otherwise
  - getAttributeInfoCount
```
public int getAttributeInfoCount()
```
    Returns the attributes_count of this CodeAttribute instance.
    
    Returns:
    
    the attributes_count of this CodeAttribute instance
  - getAttributeLength
```
public int getAttributeLength()
```
    Returns the attribute_length of this CodeAttribute instance.
    
    Specified by:
    
    getAttributeLength in class AttributeInfo
    
    Returns:
    
    the attribute_length of this CodeAttribute instance
  - getCodeLength
```
public int getCodeLength()
```
    Returns the code_length of this CodeAttribute instance.
    
    Returns:
    
    the code_length of this CodeAttribute instance
  - getExceptionTableLength
```
public int getExceptionTableLength()
```
    Returns the exception_table_length of this CodeAttribute instance.
    
    Returns:
    
    the exception_table_length of this CodeAttribute instance
  - getMaxLocals
```
public int getMaxLocals()
```
    Returns the max_locals of this CodeAttribute instance.
    
    Returns:
    
    the max_locals of this CodeAttribute instance
  - getMaxStack
```
public int getMaxStack()
```
    Returns the max_stack of this CodeAttribute instance.
    
    Returns:
    
    the max_stack of this CodeAttribute instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this CodeAttribute instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this CodeAttribute instance
  - addAttributeInfo
```
public void addAttributeInfo(AttributeInfo attributeInfo)
```
    Attempts to add attributeInfo to this CodeAttribute instance.
    If attributeInfo is null, a NullPointerException will be thrown.
    If attributeInfo (or an AttributeInfo instance that equals attributeInfo) has already been added prior to this method call, nothing will happen.
    
    Parameters:
    
    attributeInfo - the AttributeInfo to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, attributeInfo is null
  - addExceptionHandler
```
public void addExceptionHandler(CodeAttribute.ExceptionHandler exceptionHandler)
```
    Attempts to add exceptionHandler to this CodeAttribute instance.
    If exceptionHandler is null, a NullPointerException will be thrown.
    If exceptionHandler (or an ExceptionHandler instance that equals exceptionHandler) has already been added prior to this method call, nothing will happen.
    
    Parameters:
    
    exceptionHandler - the ExceptionHandler to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, exceptionHandler is null
  - addInstruction
```
public void addInstruction(CodeAttribute.Instruction instruction)
```
    Adds instruction to this CodeAttribute instance.
    If instruction is null, a NullPointerException will be thrown.
    
    Parameters:
    
    instruction - the Instruction to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, instruction is null
  - removeAttributeInfo
```
public void removeAttributeInfo(AttributeInfo attributeInfo)
```
    Attempts to remove attributeInfo from this CodeAttribute instance.
    If attributeInfo is null, a NullPointerException will be thrown.
    If no AttributeInfo equal to attributeInfo can be found, nothing will happen.
    
    Parameters:
    
    attributeInfo - the AttributeInfo to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, attributeInfo is null
  - removeExceptionHandler
```
public void removeExceptionHandler(CodeAttribute.ExceptionHandler exceptionHandler)
```
    Attempts to remove exceptionHandler from this CodeAttribute instance.
    If exceptionHandler is null, a NullPointerException will be thrown.
    If no ExceptionHandler equal to exceptionHandler can be found, nothing will happen.
    
    Parameters:
    
    exceptionHandler - the ExceptionHandler to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, exceptionHandler is null
  - removeInstruction
```
public void removeInstruction(CodeAttribute.Instruction instruction)
```
    Attempts to remove instruction from this CodeAttribute instance.
    If instruction is null, a NullPointerException will be thrown.
    If no Instruction equal to instruction can be found, nothing will happen.
    
    Parameters:
    
    instruction - the Instruction to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, instruction is null
  - setMaxLocals
```
public void setMaxLocals(int maxLocals)
```
    Sets a new max_locals for this CodeAttribute instance.
    If maxLocals is less than 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    maxLocals - the new max_locals for this CodeAttribute instance
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, maxLocals is less than 0
  - setMaxStack
```
public void setMaxStack(int maxStack)
```
    Sets a new max_stack for this CodeAttribute instance.
    If maxStack is less than 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    maxStack - the new max_stack for this CodeAttribute instance
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, maxStack is less than 0
  - write
```
public void write(java.io.DataOutput dataOutput)
```
    Writes this CodeAttribute 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 AttributeInfo
    
    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
  - newInstance
```
public static CodeAttribute newInstance(int attributeNameIndex)
```
    Returns a new CodeAttribute instance.
    If attributeNameIndex is less than or equal to 0, an IllegalArgumentException will be thrown.
    
    Parameters:
    
    attributeNameIndex - the attribute_name_index of the new CodeAttribute instance
    
    Returns:
    
    a new CodeAttribute instance
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, attributeNameIndex is less than or equal to 0
  - filter
```
public static java.util.List<CodeAttribute> filter(Node node)
```
    Returns a List with all CodeAttributes.
    All CodeAttributes 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 CodeAttributes
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, node is null
  - find
```
public static java.util.Optional<CodeAttribute> find(MethodInfo methodInfo)
```
    Attempts to find a CodeAttribute instance in methodInfo.
    Returns an Optional with the optional CodeAttribute instance.
    If methodInfo is null, a NullPointerException will be thrown.
    
    Parameters:
    
    methodInfo - the MethodInfo to check in
    
    Returns:
    
    an Optional with the optional CodeAttribute instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, methodInfo is null

Class CodeAttribute

Nested Class Summary

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

Method Detail

getAttributeInfo

getAttributeInfo

copy

getAttributeInfos

getExceptionHandlers

getInstructions

toString

accept

containsAttributeInfo

equals

getAttributeInfoCount

getAttributeLength

getCodeLength

getExceptionTableLength

getMaxLocals

getMaxStack

hashCode

addAttributeInfo

addExceptionHandler

addInstruction

removeAttributeInfo

removeExceptionHandler

removeInstruction

setMaxLocals

setMaxStack

write

newInstance

filter

find