BoundClass (jibx-bind - JiBX binding 1.3.1 API)

java.lang.Object
- org.jibx.binding.classes.BoundClass

```
public class BoundClass
extends Object
```
Bound class handler. Each instance controls and organizes information for a class included in one or more binding definitions.

Author:

Dennis M. Sosnoski

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFactory(String fact)` Add binding factory to class.
`String`	`deriveClassName(String prefix, String suffix)` Derive generated class name for bound class.
`ClassFile`	`getClassFile()` Get bound class file information.
`String`	`getClassName()` Get bound class file name.
`ClassFile`	`getDirectMungedFile()` Get direct munged class file information, if available.
`static BoundClass`	`getInstance(ClassFile cf, BoundClass context)` Get binding information for class.
`static BoundClass`	`getInstance(String name, BoundClass context)` Get binding information for class.
`ClassItem`	`getLoadMethod(ClassItem item, ClassFile from)` Get load access method for member of this class.
`ClassFile`	`getMungedFile()` Get munged class file information.
`ClassItem`	`getStoreMethod(ClassItem item, ClassFile from)` Get store access method for member of this class.
`BindingMethod`	`getUniqueMethod(MethodBuilder builder)` Get unique method.
`BindingMethod`	`getUniqueNamed(MethodBuilder builder)` Get unique method.
`boolean`	`isDirectAccess()` Check if class being changed directly.
`boolean`	`isLimitedDirectAccess()` Check if class being changed directly with restrictions.
`static void`	`reset()` Discard cached information and reset in preparation for a new binding run.
`static void`	`setModify(File root, String pkg, String name)` Set override modification information.

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

- Method Detail
  - getClassFile
```
public ClassFile getClassFile()
```
    Get bound class file information.
    
    Returns:
    
    class file information for bound class
  - getClassName
```
public String getClassName()
```
    Get bound class file name.
    
    Returns:
    
    name of bound class
  - getDirectMungedFile
```
public ClassFile getDirectMungedFile()
```
    Get direct munged class file information, if available.
    
    Returns:
    
    class file information for class receiving binding code
  - getMungedFile
```
public ClassFile getMungedFile()
```
    Get munged class file information.
    
    Returns:
    
    class file information for class receiving binding code
  - isDirectAccess
```
public boolean isDirectAccess()
```
    Check if class being changed directly.
    
    Returns:
    
    true if bound class is being modified, false if using a surrogate
  - isLimitedDirectAccess
```
public boolean isLimitedDirectAccess()
```
    Check if class being changed directly with restrictions. This is used for the special case of modifiable Java 7 class files, which still require a separate class for most of the code generation but are modified directly with binding factory information and basic implementations of the binding interface methods.
    
    Returns:
    
    true if bound class can be modified directly with basic binding information, false if using a surrogate
  - getLoadMethod
```
public ClassItem getLoadMethod(ClassItem item,
                               ClassFile from)
                        throws org.jibx.runtime.JiBXException
```
    Get load access method for member of this class. If the access method does not already exist it's created by this call. If the access method does exist but without access from the context class, the access permission on the method is broadened (from package to protected or public, or from protected to public).
    
    Parameters:
    
    item - field or method to be accessed
    
    from - context class from which access is required
    
    Returns:
    
    the item itself if it's accessible from the required context, an access method that is accessible if the item is not itself
    
    Throws:
    
    org.jibx.runtime.JiBXException - on configuration error
  - getStoreMethod
```
public ClassItem getStoreMethod(ClassItem item,
                                ClassFile from)
                         throws org.jibx.runtime.JiBXException
```
    Get store access method for member of this class. If the access method does not already exist it's created by this call. If the access method does exist but without access from the context class, the access permission on the method is broadened (from package to protected or public, or from protected to public).
    
    Parameters:
    
    item - field or method to be accessed
    
    from - context class from which access is required
    
    Returns:
    
    the item itself if it's accessible from the required context, an access method that is accessible if the item is not itself
    
    Throws:
    
    org.jibx.runtime.JiBXException - on configuration error
  - getUniqueMethod
```
public BindingMethod getUniqueMethod(MethodBuilder builder)
                              throws org.jibx.runtime.JiBXException
```
    Get unique method. Just delegates to the modified class handling, with unique suffix appended to method name.
    
    Parameters:
    
    builder - method to be defined
    
    Returns:
    
    defined method item
    
    Throws:
    
    org.jibx.runtime.JiBXException - on configuration error
  - getUniqueNamed
```
public BindingMethod getUniqueNamed(MethodBuilder builder)
                             throws org.jibx.runtime.JiBXException
```
    Get unique method. Just delegates to the modified class handling. The supplied name is used without change.
    
    Parameters:
    
    builder - method to be defined
    
    Returns:
    
    defined method item
    
    Throws:
    
    org.jibx.runtime.JiBXException - on configuration error
  - addFactory
```
public void addFactory(String fact)
```
    Add binding factory to class. Makes sure that there's no surrogate class for code generation, then delegates to the modified class handling.
    
    Parameters:
    
    fact - binding factory name
  - getInstance
```
public static BoundClass getInstance(ClassFile cf,
                                     BoundClass context)
                              throws org.jibx.runtime.JiBXException
```
    Get binding information for class. This finds the class in which code generation for the target class takes place. Normally this class will be the target class itself, but in cases where the target class is not modifiable an alternate class will be used. This can take two forms. If the context class is provided and it is a subclass of the target class, code for the target class is instead added to the context class. If there is no context class, or if the context class is not a subclass of the target class, a unique catch-all class is used.
    
    Parameters:
    
    cf - bound class information
    
    context - context class for code generation, or null if no context
    
    Returns:
    
    binding information for class
    
    Throws:
    
    org.jibx.runtime.JiBXException - on configuration error
  - getInstance
```
public static BoundClass getInstance(String name,
                                     BoundClass context)
                              throws org.jibx.runtime.JiBXException
```
    Get binding information for class. This version takes a fully-qualified class name, calling the paired method if necessary to create a new instance.
    
    Parameters:
    
    name - fully qualified name of bound class
    
    context - context class for code generation, or null if no context
    
    Returns:
    
    binding information for class
    
    Throws:
    
    org.jibx.runtime.JiBXException - on configuration error
  - reset
```
public static void reset()
```
    Discard cached information and reset in preparation for a new binding run.
  - setModify
```
public static void setModify(File root,
                             String pkg,
                             String name)
```
    Set override modification information. This allows the binding to control directly the root directory and package for added classes, and also to set the binding name used as a modifier on the generic munge adapter class. It may be called multiple times with null values for unknown parameters that may later be overridden.
    
    Parameters:
    
    root - classpath root directory for added classes
    
    pkg - package for added classes
    
    name - binding name
  - deriveClassName
```
public String deriveClassName(String prefix,
                              String suffix)
```
    Derive generated class name for bound class. This generates a JiBX class name from the name of this class, using the supplied prefix and suffix information. The derived class name is always in the same package as the munged class for this class.
    
    Parameters:
    
    prefix - generated class name prefix
    
    suffix - generated class name suffix
    
    Returns:
    
    derived class name

Class BoundClass

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getClassFile

getClassName

getDirectMungedFile

getMungedFile

isDirectAccess

isLimitedDirectAccess

getLoadMethod

getStoreMethod

getUniqueMethod

getUniqueNamed

addFactory

getInstance

getInstance

reset

setModify

deriveClassName