oracle.javatools.db.property
Enum PropertyAction

java.lang.Object
  java.lang.Enum<PropertyAction>
      oracle.javatools.db.property.PropertyAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PropertyAction>

public enum PropertyAction
extends java.lang.Enum<PropertyAction>

Used by the PropertyManager to indicate actions available on an object basis and a per-property basis.

Since:

11

See Also:

PropertyManager.supportsAction(java.lang.String, oracle.javatools.db.property.PropertyAction), PropertyManager.canChangeProperty(oracle.javatools.db.DBObject, oracle.javatools.db.DBObject, java.lang.Object)

Enum Constant Summary

ALTER
Indicates that the supported action for changing the given property is an update - i.e.

CREATE
The action for creating a new object from scratch.

DELETE
The delete object action is never returns by #canChangeProperty, but is used by #supportsAction to query whether an object type can be deleted.

REPLACE
The action for replacing an existing object.

UNDELETE
Not available on a per-property basis, but used by the supportsAction method to test whether the given provider supports undeleting of objects.

Method Summary

void	addProperty(java.lang.String propPath)
java.util.Collection<java.lang.String>	getProperties()
static PropertyAction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PropertyAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREATE

public static final PropertyAction CREATE

The action for creating a new object from scratch. Indicates that the expected action is a "create object" when returned by #canChangeProperty, this will only (and always) be the case when the original object passed in is null and the property supported.

ALTER

public static final PropertyAction ALTER

Indicates that the supported action for changing the given property is an update - i.e. a drop/recreate is not necessary, we can alter. When used with #supportsAction this asks whether the given object type can be updated at all (i.e. whether update is supported for at least one property.

REPLACE

public static final PropertyAction REPLACE

The action for replacing an existing object. When returned by #canChangeProperty this indicates that update is not possible for changing the given property, a drop/recreate is necessary - i.e. we cannot alter.

DELETE

public static final PropertyAction DELETE

The delete object action is never returns by #canChangeProperty, but is used by #supportsAction to query whether an object type can be deleted.

UNDELETE

public static final PropertyAction UNDELETE

Not available on a per-property basis, but used by the supportsAction method to test whether the given provider supports undeleting of objects.

Method Detail

values

public static PropertyAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropertyAction c : PropertyAction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertyAction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getProperties

public java.util.Collection<java.lang.String> getProperties()

addProperty

public void addProperty(java.lang.String propPath)