joi
Class JOI

java.lang.Object
  extended byjoi.JOI

public class JOI
extends java.lang.Object

This class provides static methods for the general available inspector functionality access. It also initializes the JOI extionsions. Actually that is the XML export provider.
Therefore it requires an XML parser package compliant to JAXP 1.1 such as Xerces

Version:
1.0
Author:
Manfred Duchrow

Method Summary
static org.pf.joi.Inspector basicInspect(java.lang.Object obj)
          Inspect the given object.
static org.pf.joi.Inspector basicInspect(java.lang.String name, java.lang.Object obj)
          Inspect the given object.
static void basicInspectWait(java.lang.Object obj)
          Inspect the given object like in basicInspect().
static void basicInspectWait(java.lang.String name, java.lang.Object obj)
          Inspect the given object like in basicInspect().
static org.pf.joi.AbstractObjectSpy getBasicObjectSpy(java.lang.Object obj)
          Returns the object spy wrapper for the given object.
static org.pf.joi.AbstractObjectSpy getBasicObjectSpy(java.lang.String name, java.lang.Object obj)
          Returns the object spy wrapper for the given object.
static org.pf.joi.AbstractObjectSpy getObjectSpy(java.lang.Object obj)
          Returns the object spy wrapper for the given object.
static org.pf.joi.AbstractObjectSpy getObjectSpy(java.lang.String name, java.lang.Object obj)
          Returns the object spy wrapper for the given object.
static org.pf.joi.Inspector inspect(java.lang.Object obj)
          Inspect the given object.
static org.pf.joi.Inspector inspect(java.lang.String name, java.lang.Object obj)
          Inspect the given object.
static void inspectWait(java.lang.Object obj)
          Inspect the given object like in inspect().
static void inspectWait(java.lang.String name, java.lang.Object obj)
          Inspect the given object like in inspect().
static void printBasicXml(java.lang.Object obj)
          Writes the given object's XML representation to stdout using the basic inspector.
static void printBasicXml(java.lang.Object obj, java.io.Writer writer)
          Writes the given object's XML representation to stdout using the basic inspector.
static void printBasicXml(java.lang.String name, java.lang.Object obj)
          Writes the given object's XML representation with the specified name to stdout using the basic inspector.
static void printBasicXml(java.lang.String name, java.lang.Object obj, java.io.Writer writer)
          Writes the given object's XML representation with the specified name to the given writer using the basic inspector.
static void printXml(java.lang.Object obj)
          Writes the given object as XML representation to stdout.
static void printXml(java.lang.Object obj, java.io.Writer writer)
          Writes the given object as XML representation to the given writer.
static void printXml(java.lang.String name, java.lang.Object obj)
          Writes the given object with the specified name as XML representation to stdout.
static void printXml(java.lang.String name, java.lang.Object obj, java.io.Writer writer)
          Writes the given object with the specified name as XML representation to the given writer.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

basicInspect

public static org.pf.joi.Inspector basicInspect(java.lang.Object obj)
Inspect the given object.
That means to display the internal state of the given object's attributes. This method is always using the basic inspector.

Parameters:
obj - The object to look inside

basicInspect

public static org.pf.joi.Inspector basicInspect(java.lang.String name,
                                                java.lang.Object obj)
Inspect the given object.
That means to display the internal state of the given object's attributes. This method is always using the basic inspector.

Parameters:
name - The name of the object in its program context
obj - The object to look inside

inspect

public static org.pf.joi.Inspector inspect(java.lang.Object obj)
Inspect the given object.
That means to display the internal state of the given object's attributes. The inspector can be a specialized one for the class of the given object.

Parameters:
obj - The object to look inside

inspect

public static org.pf.joi.Inspector inspect(java.lang.String name,
                                           java.lang.Object obj)
Inspect the given object.
That means to display the internal state of the given object's attributes. The inspector can be a specialized one for the class of the given object.

Parameters:
name - The name of the object in its program context
obj - The object to look inside

basicInspectWait

public static void basicInspectWait(java.lang.Object obj)
Inspect the given object like in basicInspect().
But this method doesn't return until the inspector and all its sub-inspectors are closed again.

Parameters:
obj - The object to look inside

basicInspectWait

public static void basicInspectWait(java.lang.String name,
                                    java.lang.Object obj)
Inspect the given object like in basicInspect().
But this method doesn't return until the inspector and all its sub-inspectors are closed again.

Parameters:
name - The name of the object in its program context
obj - The object to look inside

inspectWait

public static void inspectWait(java.lang.Object obj)
Inspect the given object like in inspect().
But this method doesn't return until the inspector and all its sub-inspectors are closed again.

Parameters:
obj - The object to look inside

inspectWait

public static void inspectWait(java.lang.String name,
                               java.lang.Object obj)
Inspect the given object like in inspect().
But this method doesn't return until the inspector and all its sub-inspectors are closed again.

Parameters:
name - The name of the object in its program context
obj - The object to look inside

getBasicObjectSpy

public static org.pf.joi.AbstractObjectSpy getBasicObjectSpy(java.lang.Object obj)
Returns the object spy wrapper for the given object.
It will be wrapped by the basic inspector.

Parameters:
obj - The object to look inside

getBasicObjectSpy

public static org.pf.joi.AbstractObjectSpy getBasicObjectSpy(java.lang.String name,
                                                             java.lang.Object obj)
Returns the object spy wrapper for the given object.
It will be wrapped by the basic inspector.

Parameters:
name - The name of the object in its program context
obj - The object to look inside

getObjectSpy

public static org.pf.joi.AbstractObjectSpy getObjectSpy(java.lang.Object obj)
Returns the object spy wrapper for the given object.
It will be wrapped by the inspector that is registerd for the object's type.

Parameters:
obj - The object to look inside

getObjectSpy

public static org.pf.joi.AbstractObjectSpy getObjectSpy(java.lang.String name,
                                                        java.lang.Object obj)
Returns the object spy wrapper for the given object.
It will be wrapped by the inspector that is registerd for the object's type.

Parameters:
name - The name the object has in the program context
obj - The object to look inside

printXml

public static void printXml(java.lang.Object obj)
Writes the given object as XML representation to stdout.


printXml

public static void printXml(java.lang.String name,
                            java.lang.Object obj)
Writes the given object with the specified name as XML representation to stdout.


printXml

public static void printXml(java.lang.Object obj,
                            java.io.Writer writer)
Writes the given object as XML representation to the given writer.


printXml

public static void printXml(java.lang.String name,
                            java.lang.Object obj,
                            java.io.Writer writer)
Writes the given object with the specified name as XML representation to the given writer.


printBasicXml

public static void printBasicXml(java.lang.Object obj)
Writes the given object's XML representation to stdout using the basic inspector.


printBasicXml

public static void printBasicXml(java.lang.String name,
                                 java.lang.Object obj)
Writes the given object's XML representation with the specified name to stdout using the basic inspector.


printBasicXml

public static void printBasicXml(java.lang.Object obj,
                                 java.io.Writer writer)
Writes the given object's XML representation to stdout using the basic inspector.


printBasicXml

public static void printBasicXml(java.lang.String name,
                                 java.lang.Object obj,
                                 java.io.Writer writer)
Writes the given object's XML representation with the specified name to the given writer using the basic inspector.