org.jibx.binding.classes
Class BoundClass

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

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.
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.
static void	reset() Discard cached information and reset in preparation for a new binding run.
void	setFactoryList() Generate factory list.
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

getMungedFile

public ClassFile getMungedFile()

Get munged class file information.

Returns:

class file information for class being modified

isDirectAccess

public boolean isDirectAccess()

Check if class being changed directly.

Returns:

true if bound class is being modified, false if using a surrogate

getLoadMethod

public ClassItem getLoadMethod(ClassItem item,
                               ClassFile from)
                        throws 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:

JiBXException - on configuration error

getStoreMethod

public ClassItem getStoreMethod(ClassItem item,
                                ClassFile from)
                         throws 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:

JiBXException - on configuration error

getUniqueMethod

public BindingMethod getUniqueMethod(MethodBuilder builder)
                              throws 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:

JiBXException - on configuration error

getUniqueNamed

public BindingMethod getUniqueNamed(MethodBuilder builder)
                             throws 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:

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

setFactoryList

public void setFactoryList()
                    throws JiBXException

Generate factory list. Makes sure that there's no surrogate class for code generation, then delegates to the modified class handling.

Throws:

JiBXException - on configuration error

getInstance

public static BoundClass getInstance(ClassFile cf,
                                     BoundClass context)
                              throws 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:

JiBXException - on configuration error

getInstance

public static BoundClass getInstance(String name,
                                     BoundClass context)
                              throws 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:

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.

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