oracle.jdeveloper.jot
Interface JotElementUpdate

All Known Subinterfaces:

JotWorkAreaUpdate

public interface JotElementUpdate

Each JotElementUpdate represents changes that were detected between generations in a JotFile. An update provides accessability to modified child updates, representing children of the element who have changed. The top most JotElementUpdate in a given update message will represent only the highest changed element in the file's tree.

Field Summary

static int	ADDED This flag indicates that this element has been added to its parent.
static int	CHANGED This flag indicates that this element has changed.
static int	CHILDREN_ADDED This flag indicates that this element had children added to its child list.
static int	CHILDREN_CHANGED This flag indicates that children of this element have been modified.
static int	CHILDREN_REMOVED This flag indicates this element had children removed from its child list.
static int	REMOVED This flag indicates that this element has been removed from its parent.
static int	RENAMED This flag indicates that this element has been renamed.

Method Summary

JotElementUpdate[]	getAddedChildren()
JotElementUpdate[]	getAllModifiedChildren()
JotElement	getElement()
int	getModificationFlags()
JotElementUpdate[]	getModifiedChildren()
java.lang.String	getName()
JotElementUpdate[]	getRemovedChildren()

Field Detail

CHANGED

public static final int CHANGED

This flag indicates that this element has changed.

See Also:

Constant Field Values

ADDED

public static final int ADDED

This flag indicates that this element has been added to its parent.

See Also:

Constant Field Values

REMOVED

public static final int REMOVED

This flag indicates that this element has been removed from its parent.

See Also:

Constant Field Values

RENAMED

public static final int RENAMED

This flag indicates that this element has been renamed.

See Also:

Constant Field Values

CHILDREN_REMOVED

public static final int CHILDREN_REMOVED

This flag indicates this element had children removed from its child list.

See Also:

Constant Field Values

CHILDREN_CHANGED

public static final int CHILDREN_CHANGED

This flag indicates that children of this element have been modified.

See Also:

Constant Field Values

CHILDREN_ADDED

public static final int CHILDREN_ADDED

This flag indicates that this element had children added to its child list.

See Also:

Constant Field Values

Method Detail

getModificationFlags

public int getModificationFlags()

Returns:

the flags applicable to the modifications represented by this update.

getName

public java.lang.String getName()

Returns:

the name of this element. Ie, a fully qualified class name.

getElement

public JotElement getElement()
                      throws JotInvalidElementException

Returns:

the JotElement represented by this JotElementUpdate.

Throws:

JotInvalidElementException

getAllModifiedChildren

public JotElementUpdate[] getAllModifiedChildren()
                                          throws JotInvalidElementException

Returns:

an array of JotElementUpdate items representing children that have been modified, or null. Children that have experienced any modification, including addition and removal, will be returned.

Throws:

JotInvalidElementException

getModifiedChildren

public JotElementUpdate[] getModifiedChildren()
                                       throws JotInvalidElementException

Returns:

an array of JotElementUpdate items representing children that have been modified, or null. Only children

Throws:

JotInvalidElementException

getAddedChildren

public JotElementUpdate[] getAddedChildren()
                                    throws JotInvalidElementException

Returns:

an array of JotElementUpdate items representing children that have been added to this element, or null.

Throws:

JotInvalidElementException

getRemovedChildren

public JotElementUpdate[] getRemovedChildren()
                                      throws JotInvalidElementException

Returns:

an array of JotElementUpdate items representing children that have been removed from this element, or null.

Throws:

JotInvalidElementException