com.inductiveautomation.xopc.driver.util

Class BrowseOperationIntercept

java.lang.Object

com.inductiveautomation.xopc.driver.util.BrowseOperationIntercept

All Implemented Interfaces:

BrowseOperation

public abstract class BrowseOperationIntercept
extends java.lang.Object
implements BrowseOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected BrowseOperation	browseOperation

Constructor Summary

Constructors

Constructor and Description
BrowseOperationIntercept(BrowseOperation browseOperation)

Method Summary

Modifier and Type	Method and Description
void	browseDone(StatusCode status, java.util.List<java.lang.String> children, Guid guid) Callback for when the browsing finishes.
java.lang.String	getStartingAddress() Returns the address of a folder or object to start the browse at.
protected abstract void	interceptBrowseDone(StatusCode status, java.util.List<java.lang.String> children, Guid guid)
protected abstract java.lang.String	interceptGetStartingAddress()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

browseOperation

protected final BrowseOperation browseOperation

Constructor Detail

BrowseOperationIntercept

public BrowseOperationIntercept(BrowseOperation browseOperation)

Method Detail

getStartingAddress

public java.lang.String getStartingAddress()

Description copied from interface: BrowseOperation

Returns the address of a folder or object to start the browse at. A null or empty String indicates to browse from the root.

Specified by:

getStartingAddress in interface BrowseOperation

interceptGetStartingAddress

protected abstract java.lang.String interceptGetStartingAddress()

browseDone

public void browseDone(StatusCode status,
                       java.util.List<java.lang.String> children,
                       Guid guid)

Description copied from interface: BrowseOperation

Callback for when the browsing finishes. If the status code is not good, then nodes should be null.

Specified by:

browseDone in interface BrowseOperation

Parameters:

status - The status code for this browse. If the status is good, then nodes should be non-null, otherwise, nodes will be ignored.

children - Addresses of the child nodes under the starting address.

guid - A serial number for the address space of the driver being browsed. This should be incremented any time the browse structure is changed.

interceptBrowseDone

protected abstract void interceptBrowseDone(StatusCode status,
                                            java.util.List<java.lang.String> children,
                                            Guid guid)