Class StreamContract

java.lang.Object

neqsim.util.validation.contracts.StreamContract

All Implemented Interfaces:

ModuleContract<StreamInterface>

public class StreamContract
extends Object
implements ModuleContract<StreamInterface>

Contract for process streams.

Defines requirements and guarantees for StreamInterface implementations. AI agents can use this contract to validate stream setup before connecting to equipment.

Preconditions (what the stream needs):

• Valid thermodynamic system attached
• Flow rate > 0
• Valid name for identification

Postconditions (what run() provides):

• Calculated outlet conditions
• Phase equilibrium (if flash performed)
• Stream properties accessible via getFluid()

Version:

1.0

Author:

NeqSim

Field Summary

Fields

Modifier and Type	Field	Description
private static final StreamContract	INSTANCE	Singleton instance.
private static final double	MIN_FLOW_RATE	Minimum valid flow rate.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StreamContract()

Method Summary

Modifier and Type	Method	Description
ValidationResult	checkPostconditions(StreamInterface stream)	Check postconditions after execution.
ValidationResult	checkPreconditions(StreamInterface stream)	Check preconditions before execution.
String	getContractName()	Get the name of this contract.
static StreamContract	getInstance()	Get the singleton instance.
String	getProvidesDescription()	Get a description of what this module provides.
String	getRequirementsDescription()	Get a description of what this module requires.

Methods inherited from class Object

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

Field Details

INSTANCE

private static final StreamContract INSTANCE

Singleton instance.

MIN_FLOW_RATE

private static final double MIN_FLOW_RATE

Minimum valid flow rate.

See Also:

• Constant Field Values

Constructor Details

StreamContract

private StreamContract()

Method Details

getInstance

public static StreamContract getInstance()

Get the singleton instance.

Returns:

contract instance

getContractName

public String getContractName()

Description copied from interface: ModuleContract

Get the name of this contract.

Specified by:

getContractName in interface ModuleContract<StreamInterface>

Returns:

contract name for logging/debugging

checkPreconditions

public ValidationResult checkPreconditions(StreamInterface stream)

Description copied from interface: ModuleContract

Check preconditions before execution.

Validates that all requirements are met before running the module.

Specified by:

checkPreconditions in interface ModuleContract<StreamInterface>

Parameters:

stream - object to validate

Returns:

validation result with any precondition failures

checkPostconditions

public ValidationResult checkPostconditions(StreamInterface stream)

Description copied from interface: ModuleContract

Check postconditions after execution.

Validates that the module produced valid output.

Specified by:

checkPostconditions in interface ModuleContract<StreamInterface>

Parameters:

stream - object to validate

Returns:

validation result with any postcondition failures

getRequirementsDescription

public String getRequirementsDescription()

Description copied from interface: ModuleContract

Get a description of what this module requires.

AI agents can use this to understand setup requirements.

Specified by:

getRequirementsDescription in interface ModuleContract<StreamInterface>

Returns:

human-readable requirements description

getProvidesDescription

public String getProvidesDescription()

Description copied from interface: ModuleContract

Get a description of what this module provides.

AI agents can use this to understand available outputs.

Specified by:

getProvidesDescription in interface ModuleContract<StreamInterface>

Returns:

human-readable outputs description