ch.icosys.popjava.core.service.jobmanager.network

Class POPNetwork

java.lang.Object

ch.icosys.popjava.core.service.jobmanager.network.POPNetwork

public class POPNetwork
extends java.lang.Object

Describe a POP Network, made of POP Connector with relative members to of a POP COnnector.

Constructor Summary

Constructors

Constructor and Description
POPNetwork(java.lang.String frendlyName, POPJavaJobManager jobManager) Create a new network from 0, it will generate a new UUID for it.
POPNetwork(java.lang.String uuid, java.lang.String friendlyName, POPJavaJobManager jobManager) Initialize a POP Network from a previously existing UUID.

Method Summary

Modifier and Type	Method and Description
boolean	add(POPNode node) Add a NetworkNode to this network
boolean	equals(java.lang.Object obj)
<T extends POPConnector> T	getConnector(POPNetworkDescriptor connector) Get an already casted connector from its string.
POPConnector[]	getConnectors() All the connectors in this network
java.lang.String	getFriendlyName() The friendly name of the network, can change.
java.util.List<POPNode>	getMembers(POPNetworkDescriptor connectorName) Get NetworkNode already casted to correct type
java.lang.String	getUUID() The unique identifier across nodes of this network.
int	hashCode()
boolean	remove(POPNode node) Remove a node from this Network
void	setFriendlyName(java.lang.String friendlyName) The new friendly name
int	size() How many nodes are present in this node.
YamlNetwork	toYamlResource()

Methods inherited from class java.lang.Object

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

Constructor Detail

POPNetwork

public POPNetwork(java.lang.String frendlyName,
                  POPJavaJobManager jobManager)

Create a new network from 0, it will generate a new UUID for it.

Parameters:

frendlyName - A local name for the network.

jobManager - The job manager it is assigned to.

POPNetwork

public POPNetwork(java.lang.String uuid,
                  java.lang.String friendlyName,
                  POPJavaJobManager jobManager)

Initialize a POP Network from a previously existing UUID.

Parameters:

uuid - The previously generated UUID.

friendlyName - a friendly local name for easy recognition

jobManager - the job manager

Method Detail

getFriendlyName

public java.lang.String getFriendlyName()

The friendly name of the network, can change.

Returns:

the locally recognition name

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

The new friendly name

Parameters:

friendlyName - the locally recognition name

getUUID

public java.lang.String getUUID()

The unique identifier across nodes of this network.

Returns:

the global unique uuid of this network

getConnectors

public POPConnector[] getConnectors()

All the connectors in this network

Returns:

the connectors in this network

getConnector

public <T extends POPConnector> T getConnector(POPNetworkDescriptor connector)

Get an already casted connector from its string. Warning: Responsibility on the user to use the right return. Use ``POPConnector connector = network.getConnector(...)`` if the return is unknown.

Type Parameters:

T - How to cast the connector

Parameters:

connector - Name of the connector

Returns:

a specific connector, already casted

size

public int size()

How many nodes are present in this node.

Returns:

the number of nodes

getMembers

public java.util.List<POPNode> getMembers(POPNetworkDescriptor connectorName)

Get NetworkNode already casted to correct type

Parameters:

connectorName - Which connector we are using

Returns:

An immutable set we can loop through

add

public boolean add(POPNode node)

Add a NetworkNode to this network

Parameters:

node - The node

Returns:

true if the Node is added, false if not or not compatible

remove

public boolean remove(POPNode node)

Remove a node from this Network

Parameters:

node - The node

Returns:

true if the Node is remove, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toYamlResource

public YamlNetwork toYamlResource()