Package com.iizix.prop.vs

Class VSParticipant

java.lang.Object
com.iizix.prop.GProp<ReferenceString>
com.iizix.prop.AbstractReference<VirtualSpace>
com.iizix.prop.vs.VSReference
com.iizix.prop.vs.VSParticipant
All Implemented Interfaces:
EventListener, IGProp<ReferenceString>, IPropReference, IReferencingGProp, Cloneable
public class VSParticipant extends VSReference
The VirtualSpace participant property is a reference class to the VirtualSpace instance and interacts with the VSParticipantsHolder.
Author:
Christopher Mindus

  • Constructor Details

    • VSParticipant

      public VSParticipant()
      Creates a VirtualSpace Participant property with no name and with a null value.

    • VSParticipant

      public VSParticipant(Atom propertyAtom)
      Creates a VirtualSpace Participant property with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

    • VSParticipant

      public VSParticipant(Atom propertyAtom, String virtualSpaceReference)
      Creates a VirtualSpace Participant property with the specified name with a null value.
      Parameters:
      propertyAtom - The property atom.
      virtualSpaceReference - The VirtualSpace reference.

  • Method Details

    • virtualize

      protected VSParticipant virtualize(IAppSessionGyro appGyro, IClientSessionGyro clientGyro, VirtualSpace virtualSpace) throws CloneNotSupportedException, PropException
      Call this method to "virtualize" a property tree. This method is used at runtime in the Server for the application session of virtual instances of VirtualSpace, but also virtual instances of panels, for the individual client session. The VirtualSpace is virtualized once for the application session and is shared for parallel client sessions.

      This method is similar to cloning, but enables references that are already resolved to remain if they point to a shared instance, e.g. the VirtualSpace pointing to its participants in the application property container shared instance, or a panel with references to text IDs, assets, etc.

      It is up to the property class to handle this by overriding this method.

      Overrides:
      virtualize in class VSReference
      Parameters:
      appGyro - The application gyro instance performing the virtualization.
      clientGyro - The client gyro session, can be null if not initialized from the client gyro.
      virtualSpace - The virtualized VirtualSpace.
      Returns:
      The virtualized property.
      Throws:
      CloneNotSupportedException - If a subclass doesn't allow cloning, e.g. the client properties.
      PropException - For property errors during the virtualization.
      IllegalStateException - IllegalStateException if the property is in an invalid state, e.g. in virtualizing state.

    • verify

      public boolean verify(PropVerification verification)
      Verifies this property container. The check performed is the extension of classes and that no circular reference is present.
      Specified by:
      verify in interface IGProp<ReferenceString>
      Overrides:
      verify in class GProp<ReferenceString>
      Parameters:
      verification - The property verification class.
      Returns:
      true if verification should proceed, false if disposed of and verification should not take place.