|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.model.Node oracle.ide.model.DataContainer
public class DataContainer
Field Summary |
---|
Fields inherited from class oracle.ide.model.Node |
---|
LOG_READONLY |
Fields inherited from interface oracle.javatools.data.PropertyStorage |
---|
DATA_KEY |
Constructor Summary | |
---|---|
DataContainer()
|
|
DataContainer(java.net.URL url)
|
Method Summary | |
---|---|
boolean |
add(java.util.Collection childElements,
boolean notify)
Adds a Collection of Element objects to the child
list for the container. |
boolean |
add(Element element)
Part of the Folder interface. |
boolean |
add(Element element,
boolean notify)
|
boolean |
canAdd(Element element)
Part of the Folder interface. |
boolean |
canRemove(Element element)
Part of the Folder interface. |
protected void |
closeImpl()
Subclasses should override this method to customize the close() behavior. |
boolean |
containsChild(Element child)
Returns true if the folder contains the
specified child Element ; returns false
otherwise. |
boolean |
equals(java.lang.Object obj)
|
protected boolean |
equalsImpl(DataContainer other)
|
java.lang.String |
getBaseDirectory()
|
java.util.Iterator<Element> |
getChildren()
Part of the Element interface. |
java.util.List |
getListOfChildren()
Fulfills the public accessor part of the Folder
contract.
WARNING: it is suggested that you verify the types of each element in the
returned list, as there is no guarantee that all elements share the same
type. |
protected java.lang.Object |
getObjectStoreTarget()
|
HashStructure |
getProperties()
Returns the root HashStructure object that holds properties for this Project. |
java.lang.String |
getProperty(java.lang.String name)
Convenience method equivalent to calling project.getProperties().getString(name) . |
java.lang.String |
getProperty(java.lang.String name,
java.lang.String defaultValue)
Convenience method equivalent to calling project.getProperties().getString(name, defaultValue) . |
HashStructure |
getSharedPropertiesOnly()
This method returns the persistent HashStructure that is not user-private. |
java.net.URL |
getURL()
This override marks the URL property as transient. |
HashStructure |
getUserPropertiesOnly()
For DataContainer subtypes that distinguish between user-private properties and shared properties, this method returns only the user-private HashStructure. |
boolean |
mayHaveChildren()
Part of the Element interface. |
protected ObjectStore |
newObjectStore()
|
boolean |
remove(Element element)
Part of the Folder interface. |
boolean |
remove(Element element,
boolean notify)
|
void |
removeAll()
Removes all children from the folder. |
void |
removeAll(boolean notify)
|
protected void |
resetSubDirtyableOwners(java.util.List children)
Resets the owner of each element listed. |
protected void |
saveImpl()
Subclasses should override this method to customize the save() behavior. |
void |
setListOfChildren(java.util.List<?> list)
Fulfills the public accessor part of the Folder
contract. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Convenience method equivalent to calling project.getProperties().putString(name, value) . |
protected void |
setSubDirtyableOwner(Element element,
Dirtyable owner)
Sets the owner of this element to the specified element. |
int |
size()
Returns the current number of children in the folder. |
void |
update(java.lang.Object observed,
UpdateMessage change)
Notification message. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.ide.model.Element |
---|
getAttributes, getData |
Methods inherited from interface oracle.ide.model.Displayable |
---|
getIcon, getLongLabel, getShortLabel, getToolTipText, toString |
Constructor Detail |
---|
public DataContainer()
public DataContainer(java.net.URL url)
Method Detail |
---|
public java.net.URL getURL() throws TransientMarker
getURL
in interface Locatable
getURL
in class Node
URL
identifying this Locatable
.
TransientMarker
public HashStructure getProperties()
Subclasses that support user-private properties must override this method to return the proper chained HashStructure.
getProperties
in interface PropertyStorage
HashStructure
wrapped by this PropertyStorage.public HashStructure getUserPropertiesOnly()
getSharedPropertiesOnly()
.Subclasses that support user-private properties must override this method to return the right HashStructure.
public final HashStructure getSharedPropertiesOnly()
public final java.lang.String getProperty(java.lang.String name)
project.getProperties().getString(name)
.
public final java.lang.String getProperty(java.lang.String name, java.lang.String defaultValue)
project.getProperties().getString(name, defaultValue)
.
public final void setProperty(java.lang.String name, java.lang.String value)
project.getProperties().putString(name, value)
.
public java.util.List getListOfChildren() throws TransientMarker
Folder
contract.
WARNING: it is suggested that you verify the types of each element in the
returned list, as there is no guarantee that all elements share the same
type. Usually all of them are of type @{link Element} but there can be a
few elements of type @{link Reference} as well, this happens when a
List
view of the child elements contained
by this DataFolder
. List elements may be of type @{link Element}
or @{link Reference}.
TransientMarker
public void setListOfChildren(java.util.List<?> list)
Folder
contract.
Sets the child list of the DataFolder
instance
to match the specified List
. Only objects in the
List
that can be cast to Element
are added. The
implementation uses the DefaultFolder.add(Element)
method
to add the child to the list, so that subclass implementations can
override DefaultFolder.add(Element)
without having to also
override this method.
public boolean mayHaveChildren()
Element
interface. This implementation always
returns true
.
mayHaveChildren
in interface Element
mayHaveChildren
in class Node
true
if this Element
may contain
child Element
s.Element.mayHaveChildren()
public java.util.Iterator<Element> getChildren()
Element
interface. This implementation returns
an Iterator
over the current list of children.
getChildren
in interface Element
getChildren
in class Node
Iterator
over any child Element
s
contained by this Element
. If there are no children,
null
is returned.Element.getChildren()
public boolean canAdd(Element element)
Folder
interface. The default implementation
returns true
if and only if the specified
Element
is not null
.
canAdd
in interface Folder
element
- the Element
that is about to be added
to this Folder
.
true
if and only if the specified
Element
is not null
.Folder.canAdd(Element)
public boolean add(Element element)
Folder
interface. The specified Element
is added to the end of the child list. However, if the
Element
is null
, this method does nothing.No notification is fired by this method.
add
in interface Folder
Folder.add(oracle.ide.model.Element)
public boolean canRemove(Element element)
Folder
interface. The default implementation
returns true
if and only if the specified
Element
is not null
.
canRemove
in interface Folder
element
- the Element
that is about to be removed
from this Folder
.
true
if and only if the specified
Element
is not null
.Folder.canRemove(Element)
public boolean remove(Element element)
Folder
interface. The specified Element
is removed from the child list. However, if the Element
is
null
, this method does nothing. If the Element
occurs more than once in the child list, then only the first
instance is removed.No notification is fired by this method.
remove
in interface Folder
element
- The child object to remove.Folder.remove(Element)
public boolean containsChild(Element child)
Folder
true
if the folder contains the
specified child Element
; returns false
otherwise.
containsChild
in interface Folder
public int size()
Folder
size
in interface Folder
public void removeAll()
Folder
removeAll
in interface Folder
public boolean add(Element element, boolean notify)
public boolean remove(Element element, boolean notify)
public void removeAll(boolean notify)
public final java.lang.String getBaseDirectory()
protected void closeImpl() throws java.io.IOException
Node
Node.close()
invokes this only if the node is open, under
write lock. The Node
implementation does nothing.
closeImpl
in class Node
java.io.IOException
- if an I/O error occurred while closingprotected void saveImpl() throws java.io.IOException
Node
Node.save()
invokes this only if the node is dirty, under
write lock. The Node
implementation does nothing.
saveImpl
in class Node
java.io.IOException
- if an I/O error occurred while savingprotected ObjectStore newObjectStore()
protected java.lang.Object getObjectStoreTarget()
public void update(java.lang.Object observed, UpdateMessage change)
Observer
update
in interface Observer
observed
- the subject whose state has changed.change
- what has changed.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
protected final boolean equalsImpl(DataContainer other)
public boolean add(java.util.Collection childElements, boolean notify)
Collection
of Element
objects to the child
list for the container. Each Element
is added with the
add(Element, boolean)
method. If an Object
in the
Collection
is not an Element
or if an Element
cannot be added to the container, then it is skipped and
false
is returned; the other Element
objects in
the Collection
will still be added, however.
protected void resetSubDirtyableOwners(java.util.List children)
SubDirtyable
element. When
a sub-dirtyable element is made dirty it actually makes its owner
dirty.
protected void setSubDirtyableOwner(Element element, Dirtyable owner)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |