# Class EnclosingMethod

java.lang.Object
org.apache.bcel.classfile.Attribute
org.apache.bcel.classfile.EnclosingMethod

All Implemented Interfaces:
  `Cloneable, Node`

public class EnclosingMethod extends Attribute
This attribute exists for local or anonymous classes and ... there can be only one.

Since:
  6.0

- ## Field Summary

  ### Fields inherited from class Attribute

  `constant_pool, EMPTY_ARRAY, length, name_index, tag`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `accept(Visitor v)`
  Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
  `Attribute`
  `copy(ConstantPool constantPool)`
  Creates a deep copy of this attribute.
  `final void`
  `dump(DataOutputStream file)`
  Dumps attribute to file stream in binary format.
  `final ConstantClass`
  `getEnclosingClass()`
  Gets the enclosing class.
  `final int`
  `getEnclosingClassIndex()`
  Gets the enclosing class index.
  `final ConstantNameAndType`
  `getEnclosingMethod()`
  Gets the enclosing method.
  `final int`
  `getEnclosingMethodIndex()`
  Gets the enclosing method index.
  `final void`
  `setEnclosingClassIndex(int idx)`
  Sets the enclosing class index.
  `final void`
  `setEnclosingMethodIndex(int idx)`
  Sets the enclosing method index.

  ### Methods inherited from class Attribute

  `addAttributeReader, addAttributeReader, clone, getConstantPool, getLength, getName, getNameIndex, getTag, println, readAttribute, readAttribute, removeAttributeReader, setConstantPool, setLength, setNameIndex, toString`

  ### Methods inherited from class Object

  `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### accept

    public void accept(Visitor v)
    Description copied from class: `Attribute`
    Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.
    Specified by:
      `accept` in interface `Node`
    Specified by:
      `accept` in class `Attribute`
    Parameters:
      `v` - Visitor object.

  - ### copy

    public Attribute copy(ConstantPool constantPool)
    Description copied from class: `Attribute`
    Creates a deep copy of this attribute.
    Specified by:
      `copy` in class `Attribute`
    Parameters:
      `constantPool` - constant pool to save.
    Returns:
      deep copy of this attribute.

  - ### dump

    public final void dump(DataOutputStream file) throws IOException
    Description copied from class: `Attribute`
    Dumps attribute to file stream in binary format.
    Overrides:
      `dump` in class `Attribute`
    Parameters:
      `file` - Output file stream.
    Throws:
      `IOException` - if an I/O error occurs.

  - ### getEnclosingClass

    public final ConstantClass getEnclosingClass()
    Gets the enclosing class.
    Returns:
      the enclosing class.

  - ### getEnclosingClassIndex

    public final int getEnclosingClassIndex()
    Gets the enclosing class index.
    Returns:
      the enclosing class index.

  - ### getEnclosingMethod

    public final ConstantNameAndType getEnclosingMethod()
    Gets the enclosing method.
    Returns:
      the enclosing method.

  - ### getEnclosingMethodIndex

    public final int getEnclosingMethodIndex()
    Gets the enclosing method index.
    Returns:
      the enclosing method index.

  - ### setEnclosingClassIndex

    public final void setEnclosingClassIndex(int idx)
    Sets the enclosing class index.
    Parameters:
      `idx` - the index.

  - ### setEnclosingMethodIndex

    public final void setEnclosingMethodIndex(int idx)
    Sets the enclosing method index.
    Parameters:
      `idx` - the index.