Inheritance diagram for javolution.xml.internal.XMLContextImpl:

Collaboration diagram for javolution.xml.internal.XMLContextImpl:

Public Member Functions
void	exit ()

Static Public Member Functions
static XMLContext	enter ()

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

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

static AbstractContext	current ()

static void	inherit (AbstractContext ctx)

Protected Member Functions
XMLContext	inner ()

AbstractContext	enterInner ()

AbstractContext	getOuter ()

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

Package Functions
protected< T > XMLFormat< T >	searchFormat (Class<? extends T > type)

public< T > void	setFormat (Class<? extends T > type, XMLFormat< T > format)

Static Private Member Functions
static XMLContext	currentXMLContext ()

Private Attributes
final FastMap< Class<?>, XMLFormat<?> >	formats = new FastMap<Class<?>, XMLFormat<?>>()

AbstractContext	outer

Static Private Attributes
static final XMLFormat	OBJECT_XML = new XMLFormat.Default()

static final XMLFormat	COLLECTION_XML

static final XMLFormat	MAP_XML

static final ThreadLocal< AbstractContext >	CURRENT = new ThreadLocal<AbstractContext>()

Detailed Description

Holds the default implementation of XMLContext.

Author: Jean-Marie Dautelle

Version: 6.0, July 21, 2013

Definition at line 28 of file XMLContextImpl.java.

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 ( )

staticprivateinherited

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 ( )

staticinherited

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 )

staticinherited

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()

XMLContext javolution.xml.internal.XMLContextImpl.inner ( )

protected

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 from javolution.context.AbstractContext.

Definition at line 33 of file XMLContextImpl.java.

                                  {
         XMLContextImpl ctx = new XMLContextImpl();
         ctx.formats.putAll(formats);
         return ctx;
     }

References javolution.xml.internal.XMLContextImpl.formats.

◆ searchFormat()

protected<T> XMLFormat<T> javolution.xml.internal.XMLContextImpl.searchFormat ( Class<? extends T > type )

package

Searches the xml format for the specified type.

Reimplemented from javolution.xml.XMLContext.

Definition at line 41 of file XMLContextImpl.java.

                                                                      {
         XMLFormat xml = formats.get(type);
         if (xml != null)
             return xml;
         DefaultXMLFormat format = type.getAnnotation(DefaultXMLFormat.class);
         if (format != null) {
             Class<? extends XMLFormat> formatClass = format.value();
             try {
                 xml = formatClass.newInstance();
                 synchronized (formats) { // Required since possible concurrent use 
                     // (getFormatInContext is not a configuration method).
                     formats.put(type, xml);
                 }
                 return xml;
             } catch (Throwable ex) {
                 throw new RuntimeException(ex);
             }
         }
         // Check predefined format as last resource.
         if (Map.class.isAssignableFrom(type))
             return MAP_XML;
         if (Collection.class.isAssignableFrom(type))
             return COLLECTION_XML;
         return OBJECT_XML;
     }

References javolution.util.FastMap< K, V >.get(), javolution.xml.XMLFormat< T >.newInstance(), javolution.util.FastMap< K, V >.put(), and javolution.xml.DefaultXMLFormat.value().

Here is the call graph for this function:

◆ setFormat()

public<T> void javolution.xml.internal.XMLContextImpl.setFormat	(	Class<? extends T >	type,
		XMLFormat< T >	format
	)

package

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

Reimplemented from javolution.xml.XMLContext.

Definition at line 68 of file XMLContextImpl.java.

                                                                             {
         formats.put(type, format);
     }

References javolution.util.FastMap< K, V >.put().

Here is the call graph for this function:

Member Data Documentation

◆ COLLECTION_XML

final XMLFormat javolution.xml.internal.XMLContextImpl.COLLECTION_XML

staticprivate

Initial value:

= new XMLFormat() {
 
        @SuppressWarnings("unchecked")
        public void read(XMLFormat.InputElement xml, Object obj)
                throws XMLStreamException {
            Collection collection = (Collection) obj;
            while (xml.hasNext()) {
                collection.add(xml.getNext());
            }
        }
 
        public void write(Object obj, XMLFormat.OutputElement xml)
                throws XMLStreamException {
            Collection collection = (Collection) obj;
            for (Iterator i = collection.iterator(); i.hasNext();) {
                xml.add(i.next());
            }
        }
 
    }

Holds the default XML representation for java.util.Collection instances. This representation consists of nested XML elements one for each element of the collection. The elements' order is defined by the collection iterator order. Collections are deserialized using their default constructor.

Definition at line 89 of file XMLContextImpl.java.

◆ 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().

◆ formats

final FastMap<Class<?>, XMLFormat<?> > javolution.xml.internal.XMLContextImpl.formats = new FastMap<Class<?>, XMLFormat<?>>()

private

Definition at line 30 of file XMLContextImpl.java.

Referenced by javolution.xml.internal.XMLContextImpl.inner().

◆ MAP_XML

final XMLFormat javolution.xml.internal.XMLContextImpl.MAP_XML

staticprivate

Initial value:

= new XMLFormat() {
 
        @SuppressWarnings("unchecked")
        public void read(XMLFormat.InputElement xml, Object obj)
                throws XMLStreamException {
            final Map map = (Map) obj;
            while (xml.hasNext()) {
                Object key = xml.get("Key");
                Object value = xml.get("Value");
                map.put(key, value);
            }
        }
 
        public void write(Object obj, XMLFormat.OutputElement xml)
                throws XMLStreamException {
            final Map map = (Map) obj;
            for (Iterator it = map.entrySet().iterator(); it.hasNext();) {
                Map.Entry entry = (Map.Entry) it.next();
                xml.add(entry.getKey(), "Key");
                xml.add(entry.getValue(), "Value");
            }
        }
 
    }

Holds the default XML representation for java.util.Map instances. This representation consists of key/value pair as nested XML elements. For example:[code] <javolution.util.FastMap> <Key class="java.lang.String" value="ONE">

</javolution.util.FastMap>[/code]

The elements' order is defined by the map's entries iterator order. Maps are deserialized using their default constructor.

Definition at line 126 of file XMLContextImpl.java.

◆ OBJECT_XML

final XMLFormat javolution.xml.internal.XMLContextImpl.OBJECT_XML = new XMLFormat.Default()

staticprivate

Holds the static XML format for java.lang.Object.class instances. The XML representation consists of the text representation of the object as a "value" attribute.

Definition at line 80 of file XMLContextImpl.java.

◆ 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:

XMLContextImpl.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Package Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

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

◆ COLLECTION_XML

◆ CURRENT

◆ formats

◆ MAP_XML

◆ OBJECT_XML

◆ outer