public class DebugChemObject extends ChemObject implements IChemObject
Constructor and Description |
---|
DebugChemObject() |
DebugChemObject(IChemObject object) |
Modifier and Type | Method and Description |
---|---|
void |
addListener(IChemObjectListener col)
Use this to add yourself to this IChemObject as a listener.
|
void |
addProperties(Map<Object,Object> properties)
Sets the properties of this object.
|
Object |
clone()
Clones this
IChemObject . |
IChemObjectBuilder |
getBuilder()
Returns a
IChemObjectBuilder for the data classes that extend
this class. |
boolean |
getFlag(int flagType)
Returns the value of a given flag.
|
boolean[] |
getFlags()
Returns the whole set of flags.
|
String |
getID()
Returns the identifier (ID) of this object.
|
int |
getListenerCount()
Returns the number of ChemObjectListeners registered with this object.
|
boolean |
getNotification()
Returns the flag that indicates whether notification messages are sent around.
|
Map<Object,Object> |
getProperties()
Returns a Map with the IChemObject's properties.
|
<T> T |
getProperty(Object description)
Returns a property for the IChemObject.
|
<T> T |
getProperty(Object description,
Class<T> c)
Access a property of the given description and cast the specified class.
|
void |
notifyChanged()
This should be triggered by an method that changes the content of an object
to that the registered listeners can react to it.
|
void |
notifyChanged(IChemObjectChangeEvent evt)
This should be triggered by an method that changes the content of an object
to that the registered listeners can react to it.
|
void |
removeListener(IChemObjectListener col)
Use this to remove a ChemObjectListener from the ListenerList of this
IChemObject.
|
void |
removeProperty(Object description)
Removes a property for a IChemObject.
|
void |
setFlag(int flagType,
boolean flagValue)
Sets the value of some flag.
|
void |
setFlags(boolean[] flagsNew)
Sets the whole set of flags.
|
void |
setID(String identifier)
Sets the identifier (ID) of this object.
|
void |
setNotification(boolean bool)
Set a flag to use or not use notification.
|
void |
setProperties(Map<Object,Object> properties)
Set the properties of this object to the provided map (shallow copy).
|
void |
setProperty(Object description,
Object property)
Sets a property for a IChemObject.
|
compare, getFlagValue, shallowCopy
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFlagValue, toString
public DebugChemObject(IChemObject object)
public DebugChemObject()
public void addListener(IChemObjectListener col)
addListener
in interface IChemObject
addListener
in class ChemObject
col
- the ChemObjectListenerChemObject.removeListener(org.openscience.cdk.interfaces.IChemObjectListener)
public int getListenerCount()
getListenerCount
in interface IChemObject
getListenerCount
in class ChemObject
public void removeListener(IChemObjectListener col)
removeListener
in interface IChemObject
removeListener
in class ChemObject
col
- The ChemObjectListener to be removedChemObject.addListener(org.openscience.cdk.interfaces.IChemObjectListener)
public void notifyChanged()
notifyChanged
in interface IChemObject
notifyChanged
in class ChemObject
public void notifyChanged(IChemObjectChangeEvent evt)
notifyChanged
in interface IChemObject
notifyChanged
in class ChemObject
evt
- A ChemObjectChangeEvent pointing to the source of where
the change happenedpublic void setProperty(Object description, Object property)
setProperty
in interface IChemObject
setProperty
in class ChemObject
description
- An object description of the property (most likely a
unique string)property
- An object with the property itselfChemObject.getProperty(java.lang.Object)
,
ChemObject.removeProperty(java.lang.Object)
public void removeProperty(Object description)
removeProperty
in interface IChemObject
removeProperty
in class ChemObject
description
- The object description of the property (most likely a
unique string)ChemObject.setProperty(java.lang.Object, java.lang.Object)
,
ChemObject.getProperty(java.lang.Object)
public <T> T getProperty(Object description)
getProperty
in interface IChemObject
getProperty
in class ChemObject
T
- generic return typedescription
- An object description of the property (most likely a
unique string)ChemObject.setProperty(java.lang.Object, java.lang.Object)
,
ChemObject.removeProperty(java.lang.Object)
public <T> T getProperty(Object description, Class<T> c)
IAtom atom = new Atom("C");
atom.setProperty("number", 1); // set an integer property
// access the property and automatically cast to an int
Integer number = atom.getProperty("number");
// if the method is in a chain or needs to be nested the type
// can be provided
methodAcceptingInt(atom.getProperty("number", Integer.class));
// the type cannot be checked and so...
String number = atom.getProperty("number"); // ClassCastException
// if the type is provided a more meaningful error is thrown
atom.getProperty("number", String.class); // IllegalArgumentException
getProperty
in interface IChemObject
getProperty
in class ChemObject
T
- generic type (of provided class)description
- description of a property (normally a string)c
- type of the value to be returnedIChemObject.getProperty(Object)
,
IChemObject.addProperties(java.util.Map)
public Map<Object,Object> getProperties()
getProperties
in interface IChemObject
getProperties
in class ChemObject
ChemObject.addProperties(java.util.Map<java.lang.Object, java.lang.Object>)
public String getID()
getID
in interface IChemObject
getID
in class ChemObject
ChemObject.setID(java.lang.String)
public void setID(String identifier)
setID
in interface IChemObject
setID
in class ChemObject
identifier
- a String representing the ID valueChemObject.getID()
public void setFlag(int flagType, boolean flagValue)
CDKConstants.ISAROMATIC
or CDKConstants.VISITED
). The flags are
intrinsic internal properties and should not be used to store custom
values, please use IChemObject.setProperty(Object, Object)
.
// set this chem object to be aromatic
chemObject.setFlag(CDKConstants.ISAROMATIC, Boolean.TRUE);
// ...
// indicate we have visited this chem object
chemObject.setFlag(CDKConstants.VISITED, Boolean.TRUE);
setFlag
in interface IChemObject
setFlag
in class ChemObject
flagType
- flag to set the value forflagValue
- value to assign to flagIChemObject.getFlag(int)
,
CDKConstants
public boolean getFlag(int flagType)
CDKConstants.ISAROMATIC
).
if(chemObject.getFlag(CDKConstants.ISAROMATIC)){
// handle aromatic flag on this chem object
}
getFlag
in interface IChemObject
getFlag
in class ChemObject
flagType
- flag to retrieve the value offlag_type
is setIChemObject.setFlag(int, boolean)
,
CDKConstants
public void setProperties(Map<Object,Object> properties)
setProperties
in interface IChemObject
setProperties
in class ChemObject
properties
- map key-value pairspublic void addProperties(Map<Object,Object> properties)
addProperties
in interface IChemObject
addProperties
in class ChemObject
properties
- a Hashtable specifying the property valuesChemObject.getProperties()
public void setFlags(boolean[] flagsNew)
setFlags
in interface IChemObject
setFlags
in class ChemObject
flagsNew
- the new flags.ChemObject.getFlags()
public boolean[] getFlags()
getFlags
in interface IChemObject
getFlags
in class ChemObject
ChemObject.setFlags(boolean[])
public Object clone() throws CloneNotSupportedException
IChemObject
. It clones the identifier, flags,
properties and pointer vectors. The ChemObjectListeners are not cloned, and
neither is the content of the pointer vectors.clone
in interface IChemObject
clone
in class ChemObject
CloneNotSupportedException
- if the IChemObject cannot be clonedpublic IChemObjectBuilder getBuilder()
IChemObjectBuilder
for the data classes that extend
this class.getBuilder
in interface ICDKObject
getBuilder
in class ChemObject
IChemObjectBuilder
matching this ICDKObject
public void setNotification(boolean bool)
setNotification
in interface IChemObject
setNotification
in class ChemObject
bool
- if true, then notification messages are sent.IChemObject.getNotification()
public boolean getNotification()
getNotification
in interface IChemObject
getNotification
in class ChemObject
IChemObject.setNotification(boolean)
Copyright © 2021. All rights reserved.