gcs
Interface GcsFactory

All Known Implementing Classes:
SpreadGcsFactory

public interface GcsFactory

Interface for abstract factory pattern. Its overridden methods can be used to create concrete instances of classes defined in gcs packet.

Author:
tkob

Method Summary
 GcsConnection createGcsConnection()
          Returns a concrete implementation of GcsConnection.
 GcsException createGcsException()
          Returns a concrete implementation of GcsException.
 GcsException createGcsException(java.lang.String message)
          Returns a concrete implementation of GcsException.
 GcsException createGcsException(java.lang.String message, java.lang.Throwable cause)
          Returns a certain implementation of GcsException.
 GcsGroup createGcsGroup()
          Returns a concrete implementation of GcsGroup.
 GcsGroupID createGcsGroupID()
          Returns a concrete implementation of GcsGroupID.
 GcsMembershipInfo createGcsMembershipInfo()
          Returns a concrete implementation of GcsMembershipInfo .
 GcsMessage createGcsMessage()
          Returns a concrete implementation of GcsMessage.
 GcsMessageFactory createGcsMessageFactory(GcsMessage message)
          Returns a concrete implementation of GcsMessageFactory .
 GcsMessageListener createGcsMessageListener(ProfileEntity mySessionReference)
          Returns a concrete implementation of GcsMessageListener.
 GcsVersion createGcsVersion()
          Returns a concrete implementation of GcsVersion.
 GcsSettings readSettings(org.jdom.Element element)
          Used for reading settings concerning a concrete group communication system implementation.
 

Method Detail

createGcsConnection

GcsConnection createGcsConnection()
Returns a concrete implementation of GcsConnection.

Returns:
new GcsConnection object
See Also:
GcsConnection

createGcsException

GcsException createGcsException()
Returns a concrete implementation of GcsException.

Returns:
new GcsException object
See Also:
GcsException

createGcsException

GcsException createGcsException(java.lang.String message)
Returns a concrete implementation of GcsException.

Returns:
new GcsException object
See Also:
GcsException

createGcsException

GcsException createGcsException(java.lang.String message,
                                java.lang.Throwable cause)
Returns a certain implementation of GcsException.

Returns:
new GcsException object
See Also:
GcsException

createGcsGroup

GcsGroup createGcsGroup()
Returns a concrete implementation of GcsGroup.

Returns:
new GcsGroup object
See Also:
GcsGroup

createGcsGroupID

GcsGroupID createGcsGroupID()
Returns a concrete implementation of GcsGroupID.

Returns:
new GcsGroupID object
See Also:
GcsGroupID

createGcsMembershipInfo

GcsMembershipInfo createGcsMembershipInfo()
Returns a concrete implementation of GcsMembershipInfo .

Returns:
new GcsMembershipInfo object
See Also:
GcsMembershipInfo

createGcsMessage

GcsMessage createGcsMessage()
Returns a concrete implementation of GcsMessage.

Returns:
new GcsMessage object
See Also:
GcsMessage

createGcsMessageFactory

GcsMessageFactory createGcsMessageFactory(GcsMessage message)
Returns a concrete implementation of GcsMessageFactory .

Returns:
new GcsMessageFactory object
See Also:
GcsMessageFactory

createGcsMessageListener

GcsMessageListener createGcsMessageListener(ProfileEntity mySessionReference)
Returns a concrete implementation of GcsMessageListener.

Returns:
new GcsMessageListener object
See Also:
GcsMessageListener

createGcsVersion

GcsVersion createGcsVersion()
Returns a concrete implementation of GcsVersion.

Returns:
new GcsVersion object
See Also:
GcsVersion

readSettings

GcsSettings readSettings(org.jdom.Element element)
                         throws GcsException
Used for reading settings concerning a concrete group communication system implementation. As a result it returns new GcsSettings object.

Parameters:
element - a XML section concerning concrete group communication system implementation
Returns:
a new GcsSettings object
Throws:
GcsException - if problems were encountered during reading the XML file or creating GcsSetting object