com.goldencode.p2j.ui

Class NoopComHandle

java.lang.Object

com.goldencode.p2j.util.LazyUndoable

com.goldencode.p2j.util.BaseDataType

com.goldencode.p2j.util.comhandle

com.goldencode.p2j.ui.NoopComHandle

All Implemented Interfaces:

Undoable, java.io.Externalizable, java.io.Serializable, java.lang.Comparable

public class NoopComHandle
extends comhandle

The class allows to call any com method or com property that turns into a no-operation. For more info see NoopCom.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.util.BaseDataType

BaseDataType.Type

Field Summary

Fields inherited from class com.goldencode.p2j.util.comhandle

EMPTY, value, ZERO_RESOURCE

Constructor Summary

Constructors

Constructor and Description
NoopComHandle()

Method Summary

Modifier and Type	Method and Description
BaseDataType	call(java.lang.String methodName, java.lang.Object... params) Calls a COM-method without parameters on the COM-object stored in this com-handle.
comhandle	chain(java.lang.String property) Chains access to COM property/methods.
comhandle	chainCall(java.lang.String methodName, java.lang.Object... params) Calls a COM-method without parameters on the COM-object stored in this com-handle.
NoopComHandle	duplicate() Does the same as standard clone() method but returns an instance of BaseDataType and doesn't throw the CloneNotSupportedException.
BaseDataType	getProperty(java.lang.String prop) Obtain a property value from the COM object stored in this handle.
BaseDataType	instantiateDefault() Creates a new instance of the same type that represents the default initialized value.
BaseDataType	instantiateUnknown() Creates a new instance of the same type that represents the unknown value.
void	setIndexedProperty(java.lang.String prop, java.lang.Object newVal, java.lang.Object... indices) Sets a COM property for the COM object stored by the handle, with arbitrary indices.
void	setProperty(java.lang.String prop, java.lang.Object newVal) Sets a COM property for the COM object stored by the handle.
void	setUnknown() Sets the state of this instance's unknown value flag to true.

Methods inherited from class com.goldencode.p2j.util.comhandle

_isValid, assign, assign, assign, assign, compareTo, defaultFormatString, fromResourceId, fromString, getIndexedProperty, getName, getResource, getType, hashCode, isUnknown, isValid, readExternal, removeResource, resourceId, setName, showAccessError, toString, toString, toStringExport, toStringMessage, unwrapComObject, writeExternal

Methods inherited from class com.goldencode.p2j.util.BaseDataType

assign, calcFormatLength, createProxy, createProxy, deepCopy, elementsOfType, equals, fallback, formatLength, fromTypeName, generateDefault, generateUnknown, getSize, getTypeName, incompatibleTypesOnConversion, initialize, initializeDefaultExtent, instantiateDefaultExtent, invalidInitializer, isAllKnown, isAllKnown, isIncompatibleTypesOnConversion, isProxy, isUnknownValue, maximum, minimum, notUnknownValue, sameType, val, variable

Methods inherited from class com.goldencode.p2j.util.LazyUndoable

changed, checkUndoable, checkUndoable, checkUndoable, isGlobal, isUndoable, markUndoable, popBlock, rollback, setGlobal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NoopComHandle

public NoopComHandle()

Method Detail

instantiateUnknown

public BaseDataType instantiateUnknown()

Creates a new instance of the same type that represents the unknown value.

Overrides:

instantiateUnknown in class comhandle

Returns:

An instance that represents the unknown value.

instantiateDefault

public BaseDataType instantiateDefault()

Creates a new instance of the same type that represents the default initialized value.

Overrides:

instantiateDefault in class comhandle

Returns:

An instance that represents the default value.

duplicate

public NoopComHandle duplicate()

Does the same as standard clone() method but returns an instance of BaseDataType and doesn't throw the CloneNotSupportedException.

Overrides:

duplicate in class comhandle

Returns:

A clone of this instance.

setUnknown

public void setUnknown()

Sets the state of this instance's unknown value flag to true.

Warning: a separate call is needed to ensure that the data of this instance is set to the correct value.

Overrides:

setUnknown in class comhandle

setProperty

public void setProperty(java.lang.String prop,
                        java.lang.Object newVal)

Sets a COM property for the COM object stored by the handle.

Overrides:

setProperty in class comhandle

Parameters:

prop - The legacy property name. Case insensitive. If no property is found then a warning is displayed and method returns without altering the stored object.

newVal - The new value for the property. It must be of a compatible type with the property.

setIndexedProperty

public void setIndexedProperty(java.lang.String prop,
                               java.lang.Object newVal,
                               java.lang.Object... indices)

Sets a COM property for the COM object stored by the handle, with arbitrary indices.

Overrides:

setIndexedProperty in class comhandle

Parameters:

prop - The legacy property name. Case insensitive. If no property is found then a warning is displayed and method returns without altering the stored object.

newVal - The new value for the property. It must be of a compatible type with the property.

indices - A variable number of indices used to access this property's element.

getProperty

public BaseDataType getProperty(java.lang.String prop)

Obtain a property value from the COM object stored in this handle.

Overrides:

getProperty in class comhandle

Parameters:

prop - The legacy name of the property. Case insensitive. If no property is found then a warning is displayed and method returns unknown value.

Returns:

The value of the requested property or unknown on exceptions.

chain

public comhandle chain(java.lang.String property)

Chains access to COM property/methods. This call is generated when a chained construct is encountered in legacy code. For example, ch:prop1:prop2:prop-or-method will be converted to something like: ch.chain("prop1").chain("prop2").get("prop-or-method")

Overrides:

chain in class comhandle

Parameters:

property - The property to access. It should normally be a com-object property of the object stored in this comhandle.

Returns:

A comhandle to the COM object property of currently referred resource. It normally should be chained with another access for a property of method.

call

public BaseDataType call(java.lang.String methodName,
                         java.lang.Object... params)

Calls a COM-method without parameters on the COM-object stored in this com-handle.

Overrides:

call in class comhandle

Parameters:

methodName - The method name. Case insensitive. If the COM-object does not declare such method an error message is displayed and this method returns unknown value.

params - The list of actual parameters. Their types must be compatible with the parameters of called method. TODO: marshal to BDT (?) When code is generated [param] is already BDT.

Returns:

The result of the called method, if any.

chainCall

public comhandle chainCall(java.lang.String methodName,
                           java.lang.Object... params)

Calls a COM-method without parameters on the COM-object stored in this com-handle.

Overrides:

chainCall in class comhandle

Parameters:

methodName - The method name. Case insensitive. If the COM-object does not declare such method an error message is displayed and this method returns unknown value.

params - The list of actual parameters. Their types must be compatible with the parameters of called method. TODO: marshal to BDT (?) When code is generated [param] is already BDT.

Returns:

The result of the called method, in a comhandle, so it can be used in a chained call or property access.