org.oddjob.arooa.parsing

Class CutAndPasteSupport

java.lang.Object

org.oddjob.arooa.parsing.CutAndPasteSupport

public class CutAndPasteSupport
extends Object

Provide support for Cutting and Pasting from any form of parsed ArooaConfiguration.

Author:

rob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CutAndPasteSupport.ReplaceResult<P extends ParseContext<P>> Result for replace.

Constructor Summary

Constructors

Constructor and Description
CutAndPasteSupport(ArooaContext instanceContext) Constructor.

Method Summary

Modifier and Type	Method and Description
static String	copy(ParseContext<?> context) Copy a Parse Context's configuration to XML.
void	cut(ArooaContext childContext) Remove the component who's context is given.
static int	cut(ParseContext<?> parentContext, ParseContext<?> childContext) Cut when the parent context is known.
ConfigurationHandle<ArooaContext>	paste(int index, ArooaConfiguration config) Paste the ArooaConfiguration.
static <P extends ParseContext<P>> ConfigurationHandle<P>	paste(P parentContext, int index, ArooaConfiguration config) Add any configuration to the parent context.
CutAndPasteSupport.ReplaceResult<ArooaContext>	replace(ArooaContext childContext, ArooaConfiguration config) Replace the childContext with the given configuration.
static <P extends ParseContext<P>> CutAndPasteSupport.ReplaceResult<P>	replace(P parentContext, P childContext, ArooaConfiguration config) Replaces a child context with the contents of the configuration.
boolean	supportsPaste() Does this instance support pasting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CutAndPasteSupport

public CutAndPasteSupport(ArooaContext instanceContext)

Constructor.

Parameters:

instanceContext - The context of the component we are providing the support for.

Method Detail

supportsPaste

public boolean supportsPaste()

Does this instance support pasting.

Returns:

cut

public void cut(ArooaContext childContext)
         throws ArooaConfigurationException

Remove the component who's context is given.

Parameters:

childContext -

Throws:

ArooaConfigurationException

paste

public ConfigurationHandle<ArooaContext> paste(int index,
                                               ArooaConfiguration config)
                                        throws ArooaParseException,
                                               ArooaConfigurationException

Paste the ArooaConfiguration.

Parameters:

index -

config -

Returns:

Throws:

ArooaParseException

ArooaConfigurationException

replace

public CutAndPasteSupport.ReplaceResult<ArooaContext> replace(ArooaContext childContext,
                                                              ArooaConfiguration config)
                                                       throws ArooaParseException,
                                                              ArooaConfigurationException

Replace the childContext with the given configuration.

Parameters:

childContext -

config -

Returns:

Throws:

ArooaParseException

ArooaConfigurationException

cut

public static int cut(ParseContext<?> parentContext,
                      ParseContext<?> childContext)
               throws ArooaConfigurationException

Cut when the parent context is known.

Parameters:

parentContext -

childContext -

Returns:

The index the node was cut from.

Throws:

ArooaConfigurationException

paste

public static <P extends ParseContext<P>> ConfigurationHandle<P> paste(P parentContext,
                                                                       int index,
                                                                       ArooaConfiguration config)
                                                                throws ArooaParseException

Add any configuration to the parent context.

Parameters:

parentContext -

index -

Throws:

ArooaParseException

replace

public static <P extends ParseContext<P>> CutAndPasteSupport.ReplaceResult<P> replace(P parentContext,
                                                                                      P childContext,
                                                                                      ArooaConfiguration config)
                                                                               throws ArooaParseException,
                                                                                      ArooaConfigurationException

Replaces a child context with the contents of the configuration.

Parameters:

parentContext -

childContext -

config -

Throws:

ArooaParseException

ArooaConfigurationException

copy

public static String copy(ParseContext<?> context)

Copy a Parse Context's configuration to XML.

Parameters:

context - The parse context.

Returns:

The XML.