OpenJDK 27 · javax.management.relation.RelationTypeSupport

A RelationTypeSupport object implements the RelationType interface.

It represents a relation type, providing role information for each role expected to be supported in every relation of that type.

A relation type includes a relation type name and a list of role infos (represented by RoleInfo objects).

A relation type has to be declared in the Relation Service:

- either using the createRelationType() method, where a RelationTypeSupport object will be created and kept in the Relation Service

- either using the addRelationType() method where the user has to create an object implementing the RelationType interface, and this object will be used as representing a relation type in the Relation Service.

The serialVersionUID of this class is 4611072955724144607L.

Field Summary

Modifier and Type	Field and Description
private boolean	isInRelationService
private Map<String, RoleInfo>	roleName2InfoMap
private static final ObjectStreamField[]	serialPersistentFields
private static final long	serialVersionUID
private String	typeName

Constructor Summary

Access	Constructor and Description
public	RelationTypeSupport(String Name of relation type relationTypeName, RoleInfo[] List of role definitions (RoleInfo objects) roleInfoArray) Constructor where all role definitions are dynamically created and passed as parameter.
protected	RelationTypeSupport(String Name of relation type. relationTypeName) Constructor to be used for subclasses.

Method Summary

Modifier and Type	Method and Description
protected void	addRoleInfo(RoleInfo role info to be added. roleInfo) Add a role info.
pack-priv static void	checkRoleInfos(RoleInfo[] roleInfoArray)
public String	Returns: the relation type name. getRelationTypeName() Implements javax.management.relation.RelationType.getRelationTypeName. Returns the relation type name.
public RoleInfo	Returns: RoleInfo object providing role definition does not exist getRoleInfo(String role info name roleInfoName) Implements javax.management.relation.RelationType.getRoleInfo. Returns the role info (RoleInfo object) for the given role info name (null if not found).
public List<RoleInfo>	getRoleInfos() Implements javax.management.relation.RelationType.getRoleInfos. Returns the list of role definitions (ArrayList of RoleInfo objects).
private void	initMembers(String relationTypeName, RoleInfo[] roleInfoArray)
private void	readObject(ObjectInputStream in) Deserializes a `RelationTypeSupport` from an `ObjectInputStream`.
pack-priv void	setRelationServiceFlag(boolean flag)
private void	writeObject(ObjectOutputStream out) Serializes a `RelationTypeSupport` to an `ObjectOutputStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

isInRelationService	back to summary
private boolean isInRelationService

roleName2InfoMap	back to summary
private Map<String, RoleInfo> roleName2InfoMap

serialPersistentFields	back to summary
private static final ObjectStreamField[] serialPersistentFields Serial Fields: typeName:`String` Relation type name roleName2InfoMap:`Map` `Map` holding the mapping: <role name (`String`)> -> <role info (`RoleInfo` object)> isInRelationService:boolean Flag specifying whether the relation type has been declared in the Relation Service (so can no longer be updated)

serialVersionUID	back to summary
private static final long serialVersionUID

typeName	back to summary
private String typeName

Constructor Detail

RelationTypeSupport	back to summary
public RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException Constructor where all role definitions are dynamically created and passed as parameter. Parameters relationTypeName:String Name of relation type roleInfoArray:RoleInfo[] List of role definitions (RoleInfo objects) Exceptions IllegalArgumentException: if null parameter InvalidRelationTypeException: if: - the same name has been used for two different roles - no role info provided - one null role info provided

RelationTypeSupport

back to summary

public RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException

Constructor where all role definitions are dynamically created and passed as parameter.

Parameters

relationTypeName:String: Name of relation type
roleInfoArray:RoleInfo[]: List of role definitions (RoleInfo objects)

Exceptions

IllegalArgumentException:

if null parameter

InvalidRelationTypeException:

if:

- the same name has been used for two different roles

- no role info provided

- one null role info provided

RelationTypeSupport	back to summary
protected RelationTypeSupport(String relationTypeName) Constructor to be used for subclasses. Parameters relationTypeName:String Name of relation type. Exceptions IllegalArgumentException: if null parameter.

RelationTypeSupport

back to summary

protected RelationTypeSupport(String relationTypeName)

Constructor to be used for subclasses.

Parameters

relationTypeName:String: Name of relation type.

Exceptions

IllegalArgumentException:: if null parameter.

Method Detail

addRoleInfo	back to summary
protected void addRoleInfo(RoleInfo roleInfo) throws IllegalArgumentException, InvalidRelationTypeException Add a role info. This method of course should not be used after the creation of the relation type, because updating it would invalidate that the relations created associated to that type still conform to it. Can throw a RuntimeException if trying to update a relation type declared in the Relation Service. Parameters roleInfo:RoleInfo role info to be added. Exceptions IllegalArgumentException: if null parameter. InvalidRelationTypeException: if there is already a role info in current relation type with the same name.

addRoleInfo

back to summary

protected void addRoleInfo(RoleInfo roleInfo) throws IllegalArgumentException, InvalidRelationTypeException

Add a role info. This method of course should not be used after the creation of the relation type, because updating it would invalidate that the relations created associated to that type still conform to it. Can throw a RuntimeException if trying to update a relation type declared in the Relation Service.

Parameters

roleInfo:RoleInfo: role info to be added.

Exceptions

IllegalArgumentException:: if null parameter.
InvalidRelationTypeException:: if there is already a role info in current relation type with the same name.

checkRoleInfos	back to summary
pack-priv static void checkRoleInfos(RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException

getRelationTypeName	back to summary
public String getRelationTypeName() Implements javax.management.relation.RelationType.getRelationTypeName. Returns the relation type name. Returns:String the relation type name.

getRelationTypeName

back to summary

public String getRelationTypeName()

Implements javax.management.relation.RelationType.getRelationTypeName.

Returns the relation type name.

Returns:String: the relation type name.

getRoleInfo	back to summary
public RoleInfo getRoleInfo(String roleInfoName) throws IllegalArgumentException, RoleInfoNotFoundException Implements javax.management.relation.RelationType.getRoleInfo. Returns the role info (RoleInfo object) for the given role info name (null if not found). Parameters roleInfoName:String role info name Returns:RoleInfo RoleInfo object providing role definition does not exist Exceptions IllegalArgumentException: if null parameter RoleInfoNotFoundException: if no role info with that name in relation type.

getRoleInfo

back to summary

public RoleInfo getRoleInfo(String roleInfoName) throws IllegalArgumentException, RoleInfoNotFoundException

Implements javax.management.relation.RelationType.getRoleInfo.

Returns the role info (RoleInfo object) for the given role info name (null if not found).

Parameters

roleInfoName:String: role info name

Returns:RoleInfo

RoleInfo object providing role definition does not exist

Exceptions

IllegalArgumentException:: if null parameter
RoleInfoNotFoundException:: if no role info with that name in relation type.

getRoleInfos	back to summary
public List<RoleInfo> getRoleInfos() Implements javax.management.relation.RelationType.getRoleInfos. Returns the list of role definitions (ArrayList of RoleInfo objects).

getRoleInfos

back to summary

public List<RoleInfo> getRoleInfos()

Implements javax.management.relation.RelationType.getRoleInfos.

Returns the list of role definitions (ArrayList of RoleInfo objects).

initMembers	back to summary
private void initMembers(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Deserializes a `RelationTypeSupport` from an `ObjectInputStream`.

setRelationServiceFlag	back to summary
pack-priv void setRelationServiceFlag(boolean flag)

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Serializes a `RelationTypeSupport` to an `ObjectOutputStream`.

public Class RelationTypeSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail