org.exolab.jms.config
Class AdministeredTopic

java.lang.Object
  extended by org.exolab.jms.config.AdministeredTopic
All Implemented Interfaces:
java.io.Serializable

public class AdministeredTopic
extends java.lang.Object
implements java.io.Serializable

This element defines an administered topic, and any durable subscribers.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
AdministeredTopic()
           
 
Method Summary
 void addSubscriber(int index, Subscriber vSubscriber)
          Method addSubscriber
 void addSubscriber(Subscriber vSubscriber)
          Method addSubscriber
 void clearSubscriber()
          Method clearSubscriber
 java.util.Enumeration enumerateSubscriber()
          Method enumerateSubscriber
 java.lang.String getName()
          Returns the value of field 'name'.
 Subscriber[] getSubscriber()
          Method getSubscriber
 Subscriber getSubscriber(int index)
          Method getSubscriber
 int getSubscriberCount()
          Method getSubscriberCount
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 boolean removeSubscriber(Subscriber vSubscriber)
          Method removeSubscriber
 void setName(java.lang.String name)
          Sets the value of field 'name'.
 void setSubscriber(int index, Subscriber vSubscriber)
          Method setSubscriber
 void setSubscriber(Subscriber[] subscriberArray)
          Method setSubscriber
static java.lang.Object unmarshal(java.io.Reader reader)
          Method unmarshal
 void validate()
          Method validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdministeredTopic

public AdministeredTopic()
Method Detail

addSubscriber

public void addSubscriber(Subscriber vSubscriber)
                   throws java.lang.IndexOutOfBoundsException
Method addSubscriber

Parameters:
vSubscriber -
Throws:
java.lang.IndexOutOfBoundsException

addSubscriber

public void addSubscriber(int index,
                          Subscriber vSubscriber)
                   throws java.lang.IndexOutOfBoundsException
Method addSubscriber

Parameters:
index -
vSubscriber -
Throws:
java.lang.IndexOutOfBoundsException

clearSubscriber

public void clearSubscriber()
Method clearSubscriber


enumerateSubscriber

public java.util.Enumeration enumerateSubscriber()
Method enumerateSubscriber

Returns:
Enumeration

getName

public java.lang.String getName()
Returns the value of field 'name'. The field 'name' has the following description: The name of the topic. This must be unique.

Returns:
String

getSubscriber

public Subscriber getSubscriber(int index)
                         throws java.lang.IndexOutOfBoundsException
Method getSubscriber

Parameters:
index -
Returns:
Subscriber
Throws:
java.lang.IndexOutOfBoundsException

getSubscriber

public Subscriber[] getSubscriber()
Method getSubscriber

Returns:
Subscriber

getSubscriberCount

public int getSubscriberCount()
Method getSubscriberCount

Returns:
int

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

removeSubscriber

public boolean removeSubscriber(Subscriber vSubscriber)
Method removeSubscriber

Parameters:
vSubscriber -
Returns:
boolean

setName

public void setName(java.lang.String name)
Sets the value of field 'name'. The field 'name' has the following description: The name of the topic. This must be unique.

Parameters:
name - the value of field 'name'.

setSubscriber

public void setSubscriber(int index,
                          Subscriber vSubscriber)
                   throws java.lang.IndexOutOfBoundsException
Method setSubscriber

Parameters:
index -
vSubscriber -
Throws:
java.lang.IndexOutOfBoundsException

setSubscriber

public void setSubscriber(Subscriber[] subscriberArray)
Method setSubscriber

Parameters:
subscriberArray -

unmarshal

public static java.lang.Object unmarshal(java.io.Reader reader)
                                  throws org.exolab.castor.xml.MarshalException,
                                         org.exolab.castor.xml.ValidationException
Method unmarshal

Parameters:
reader -
Returns:
Object
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Method validate

Throws:
org.exolab.castor.xml.ValidationException


Copyright © 1999-2005 The OpenJMS Group. All Rights Reserved.