Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method

org.opengroup.arm40.tranreport

Interface ArmTranReportFactory

public interface ArmTranReportFactory extends ArmInterface

Provides methods to create instances of the classes in the org.opengroup.arm40.tranreport package. An error callback method can be registered for objects created with this factory (see setErrorCallback). For additional details about error handling philosophy see the description of ArmTransactionFactory.

Semantics of the factory methods are provided in the description of the individual methods below.

ArmTranReportFactory is instantiated using a class loader. The actual name of the factory implementation class is obtained from the system property whose name is provided in the propertyKey constant.

Author: ARM Working Group of The Open Group

Field Summary
static StringpropertyKey
name of system property holding the implementation class name.
Method Summary
ArmApplicationRemotenewArmApplicationRemote(ArmApplicationDefinition definition, String group, String instance, String[] contextValues, ArmSystemAddress systemAddress)
Creates an ArmApplicationRemote.
ArmSystemAddressnewArmSystemAddress(short format, byte[] addressBytes, ArmID id)
Creates an ArmSystemAddress from the specified format and the input byte array.
ArmSystemAddressnewArmSystemAddress(short format, byte[] addressBytes, int offset, ArmID id)
Creates an ArmSystemAddress from the specified format and the input byte array.
ArmSystemAddressnewArmSystemAddress(short format, byte[] addressBytes, int offset, int length, ArmID id)
Creates an ArmSystemAddress from the specified format and the input byte array.
ArmTranReportnewArmTranReport(ArmApplication app, ArmTransactionDefinition definition)
Creates an object that represents an instance of a transaction.
booleansetErrorCallback(ArmErrorCallback errorCallback)
Registers an error callback for objects created through this factory.

Field Detail

propertyKey

public static final String propertyKey
name of system property holding the implementation class name.

Method Detail

newArmApplicationRemote

public ArmApplicationRemote newArmApplicationRemote(ArmApplicationDefinition definition, String group, String instance, String[] contextValues, ArmSystemAddress systemAddress)
Creates an ArmApplicationRemote. If systemAddress is null, the addressing information for the local system is used.

Parameters: definition metadata describing the type of the ARM application. Must not be null. group Name of the group the application belongs to. May be null. instance Name this application instance is given. May be null. contextValues An array of strings providing the value parts of (name,value) context properties. May be null. systemAddress address of the remote system the application is executing on.

Returns: a new ArmApplicationRemote instance.

See Also:

newArmSystemAddress

public ArmSystemAddress newArmSystemAddress(short format, byte[] addressBytes, ArmID id)
Creates an ArmSystemAddress from the specified format and the input byte array. See the ArmSystemAddress description for more details about the parameters. The length of the address data is the length of addressBytes, if not restricted otherwise through the format parameter.

Parameters: format the address format. addressBytes a byte array containig the address data. id An optional 16-byte ID associated with the identity of the ArmSystemAddress.

Returns: a new ArmSystemAddress

newArmSystemAddress

public ArmSystemAddress newArmSystemAddress(short format, byte[] addressBytes, int offset, ArmID id)
Creates an ArmSystemAddress from the specified format and the input byte array. See the ArmSystemAddress description for more details about the parameters. The length of the address data is the length of addressBytes, if not restricted otherwise through the format parameter.

Parameters: format the address format. addressBytes a byte array containig the address data. id An optional 16-byte ID associated with the identity of the ArmSystemAddress. offset start of the address bytes within the array.

Returns: a new ArmSystemAddress

newArmSystemAddress

public ArmSystemAddress newArmSystemAddress(short format, byte[] addressBytes, int offset, int length, ArmID id)
Creates an ArmSystemAddress from the specified format and the input byte array. See the ArmSystemAddress description for more details about the parameters. The length of the address data is length, if not restricted otherwise through the format parameter.

Parameters: format the address format. addressBytes a byte array containig the address data. id An optional 16-byte ID associated with the identity of the ArmSystemAddress. offset start of the address bytes within the array. length the number of bytes of valid address data.

Returns: a new ArmSystemAddress

newArmTranReport

public ArmTranReport newArmTranReport(ArmApplication app, ArmTransactionDefinition definition)
Creates an object that represents an instance of a transaction. The metadata is supplied in an ArmTransactionDefinition object. It is scoped by an application instance, represented by ArmApplication (or its subclass, ArmApplicationRemote).

Parameters: app the application instance the transaction belongs to. definition the metadata describing the type of the transaction.

Returns: a new ArmTranReport instance.

setErrorCallback

public boolean setErrorCallback(ArmErrorCallback errorCallback)
Registers an error callback for objects created through this factory. See the error handling philosophy comment in the description of ArmTransactionFactory.

Parameters: errorCallback an application object implementing the ArmErrorCallback> interface.

Returns: true if registration is accepted.

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method