Inheritance diagram for javolution.xml.XMLContext:

Collaboration diagram for javolution.xml.XMLContext:

Public Member Functions
abstract< T > void	setFormat (Class<? extends T > type, XMLFormat< T > format)

void	exit ()

Static Public Member Functions
static XMLContext	enter ()

static< T > XMLFormat< T >	getFormat (Class<? extends T > type)

static AbstractContext	current ()

static< T extends AbstractContext > T	enter (Class< T > custom)

static void	inherit (AbstractContext ctx)

Protected Member Functions
	XMLContext ()

abstract< T > XMLFormat< T >	searchFormat (Class<? extends T > type)

AbstractContext	enterInner ()

AbstractContext	getOuter ()

abstract AbstractContext	inner ()

Static Protected Member Functions
static< T extends AbstractContext > T	current (Class< T > type)

Static Private Member Functions
static XMLContext	currentXMLContext ()

Private Attributes
AbstractContext	outer

Static Private Attributes
static final ThreadLocal< AbstractContext >	CURRENT = new ThreadLocal<AbstractContext>()

Detailed Description

A context for xml serialization/deserialization. The default xml format for any class is given by the Format inheritable annotation.

A default xml format exists for the following predefined types:



java.lang.Object (value attribute parsed/formatted using TextFormat) 

java.util.Collection 

java.util.Map

Author: Jean-Marie Dautelle

Version: 6.0 December 12, 2012

Definition at line 31 of file XMLContext.java.

Constructor & Destructor Documentation

◆ XMLContext()

javolution.xml.XMLContext.XMLContext ( )

protected

Default constructor.

Definition at line 36 of file XMLContext.java.

36 {}

Member Function Documentation

◆ current() [1/2]

static AbstractContext javolution.context.AbstractContext.current ( )

staticinherited

Returns the current context for the current thread or

null

if this thread has no context (default).

Definition at line 61 of file AbstractContext.java.

                                             {
         return AbstractContext.CURRENT.get();
     }

References javolution.context.AbstractContext.CURRENT.

Referenced by javolution.context.LogContext.currentLogContext(), javolution.context.SecurityContext.currentSecurityContext(), javolution.text.TextContext.currentTextContext(), javolution.xml.XMLContext.currentXMLContext(), javolution.context.LocalContext.enter(), javolution.context.ConcurrentContext.enter(), and javolution.context.LocalContext.Parameter< T >.get().

Here is the caller graph for this function:

◆ current() [2/2]

static <T extends AbstractContext> T javolution.context.AbstractContext.current ( Class< T > type )

staticprotectedinherited

Returns the current context of specified type or

null

if none.

Definition at line 69 of file AbstractContext.java.

                                                                           {
         AbstractContext ctx = AbstractContext.CURRENT.get();
         while (ctx != null) {
             if (type.isInstance(ctx))
                 return (T) ctx;
             ctx = ctx.outer;
         }
         return null;
     }

References javolution.context.AbstractContext.CURRENT, and javolution.context.AbstractContext.outer.

◆ currentXMLContext()

static XMLContext javolution.xml.XMLContext.currentXMLContext ( )

staticprivate

Returns the current xml context.

Definition at line 68 of file XMLContext.java.

                                                   {
         XMLContext ctx = AbstractContext.current(XMLContext.class);
         if (ctx != null)
             return ctx;
         return OSGiServices.getXMLContext();
     }

References javolution.context.AbstractContext.current(), and javolution.osgi.internal.OSGiServices.getXMLContext().

Referenced by javolution.xml.XMLContext.enter(), and javolution.xml.XMLContext.getFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enter() [1/2]

static XMLContext javolution.xml.XMLContext.enter ( )

static

Enters and returns a new xml context instance.

Definition at line 41 of file XMLContext.java.

                                      {
         return (XMLContext) XMLContext.currentXMLContext().enterInner();
     }

References javolution.xml.XMLContext.currentXMLContext(), and javolution.context.AbstractContext.enterInner().

Here is the call graph for this function:

◆ enter() [2/2]

static <T extends AbstractContext> T javolution.context.AbstractContext.enter ( Class< T > custom )

staticinherited

Enters the scope of a custom context. This method raises a SecurityException if the permission to enter contexts of the specified class is not granted. For example, the following disallow entering any custom context. [code] SecurityContext ctx = SecurityContext.enter(); try { ctx.revoke(new SecurityContext.Permission(AbstractContext.class, "enter")); ... // Cannot enter any custom context. } finally { ctx.exit(); // Back to previous security settings. }[/code]

Parameters

custom the custom context to enter.

Exceptions

IllegalArgumentException	if the specified class default constructor cannot be instantiated.
SecurityException	if SecurityContext.Permission(custom, "enter") is not granted.

See also: SecurityContext.Permission

Definition at line 101 of file AbstractContext.java.

                                                                        {
         SecurityContext.check(new Permission<T>(custom, "enter"));
         try {
             return (T) custom.newInstance().enterInner();
         } catch (InstantiationException e) {
             throw new IllegalArgumentException(
                     "Cannot instantiate instance of " + custom, e);
         } catch (IllegalAccessException e) {
             throw new IllegalArgumentException("Cannot access " + custom, e);
         }
     }

References javolution.context.SecurityContext.check().

Here is the call graph for this function:

◆ enterInner()

AbstractContext javolution.context.AbstractContext.enterInner ( )

protectedinherited

Enters the scope of an inner context which becomes the current context; the previous current context becomes the outer of this context.

Returns: the inner context entered.

Definition at line 141 of file AbstractContext.java.

                                            {
         AbstractContext inner = inner();
         inner.outer = AbstractContext.CURRENT.get();
         AbstractContext.CURRENT.set(inner);
         return inner;
     }

References javolution.context.AbstractContext.CURRENT, and javolution.context.AbstractContext.outer.

Referenced by javolution.xml.XMLContext.enter(), javolution.text.TextContext.enter(), javolution.context.LogContext.enter(), javolution.context.LocalContext.enter(), javolution.context.SecurityContext.enter(), and javolution.context.ConcurrentContext.enter().

Here is the caller graph for this function:

◆ exit()

void javolution.context.AbstractContext.exit ( )

inherited

Exits the scope of this context; the outer of this context becomes
the current context.

Exceptions

IllegalStateException if this context is not the current context.

Reimplemented in javolution.context.ConcurrentContext, and javolution.context.internal.ConcurrentContextImpl.

Definition at line 155 of file AbstractContext.java.

                        {
         if (this != AbstractContext.CURRENT.get())
             throw new IllegalStateException(
                     "This context is not the current context");
         AbstractContext.CURRENT.set(outer);
         outer = null;
     }

References javolution.context.AbstractContext.CURRENT.

◆ getFormat()

static <T> XMLFormat<T> javolution.xml.XMLContext.getFormat ( Class<? extends T > type )

static

Returns the xml format for the specified type; if none defined the default object xml format (based on TextFormat) is returned.

Definition at line 49 of file XMLContext.java.

                                                                       {
         return XMLContext.currentXMLContext().searchFormat(type);
     }

References javolution.xml.XMLContext.currentXMLContext(), and javolution.xml.XMLContext.searchFormat().

Referenced by javolution.xml.XMLBinding.getFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOuter()

AbstractContext javolution.context.AbstractContext.getOuter ( )

protectedinherited

Returns the outer context of this context or

null

if this context has no outer context.

Definition at line 167 of file AbstractContext.java.

                                          {
         return outer;
     }

◆ inherit()

static void javolution.context.AbstractContext.inherit ( AbstractContext ctx )

staticinherited

Inherits the specified context which becomes the context of the current thread. This method is particularly useful when creating new threads to make them inherits from the context stack of the parent thread. [code] //Spawns a new thread inheriting the context of the current thread. MyThread myThread = new MyThread(); myThread.inherited = AbstractContext.current(); myThread.start(); ... class MyThread extends Thread { AbstractContext inherited; public void run() { AbstractContext.inherit(inherited); // Sets current context. ... } }[/code]

Definition at line 131 of file AbstractContext.java.

                                                     {
         CURRENT.set(ctx);
     }

Referenced by javolution.context.internal.ConcurrentThreadImpl.run().

Here is the caller graph for this function:

◆ inner()

abstract AbstractContext javolution.context.AbstractContext.inner ( )

abstractprotectedinherited

Returns a new inner instance of this context inheriting the properties of this context. The new instance can be configured independently from its parent.

Reimplemented in javolution.context.internal.ConcurrentContextImpl, javolution.text.internal.TextContextImpl, javolution.context.internal.LogContextImpl, javolution.context.internal.SecurityContextImpl, javolution.xml.internal.XMLContextImpl, and javolution.context.internal.LocalContextImpl.

◆ searchFormat()

abstract <T> XMLFormat<T> javolution.xml.XMLContext.searchFormat ( Class<? extends T > type )

abstractprotected

Searches the xml format for the specified type.

Reimplemented in javolution.xml.internal.XMLContextImpl.

Referenced by javolution.xml.XMLContext.getFormat().

Here is the caller graph for this function:

◆ setFormat()

abstract <T> void javolution.xml.XMLContext.setFormat	(	Class<? extends T >	type,
		XMLFormat< T >	format
	)

abstract

Sets the xml format for the specified type (and its sub-types).

Reimplemented in javolution.xml.internal.XMLContextImpl.

Member Data Documentation

◆ CURRENT

final ThreadLocal<AbstractContext> javolution.context.AbstractContext.CURRENT = new ThreadLocal<AbstractContext>()

staticprivateinherited

Holds the last context entered (thread-local).

Definition at line 45 of file AbstractContext.java.

Referenced by javolution.context.AbstractContext.current(), javolution.context.AbstractContext.enterInner(), and javolution.context.AbstractContext.exit().

◆ outer

AbstractContext javolution.context.AbstractContext.outer

privateinherited

Holds the outer context or

null

if none (top context).

Definition at line 50 of file AbstractContext.java.

Referenced by javolution.context.AbstractContext.current(), and javolution.context.AbstractContext.enterInner().

The documentation for this class was generated from the following file:

XMLContext.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XMLContext()

Member Function Documentation

◆ current() [1/2]

◆ current() [2/2]

◆ currentXMLContext()

◆ enter() [1/2]

◆ enter() [2/2]

◆ enterInner()

◆ exit()

◆ getFormat()

◆ getOuter()

◆ inherit()

◆ inner()

◆ searchFormat()

◆ setFormat()

Member Data Documentation

◆ CURRENT

◆ outer