org.exolab.jms.config
Class AdministeredTopic

java.lang.Object
  |
  +--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 AdministeredTopic	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 -

addSubscriber

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

Method addSubscriber

Parameters:

index -

vSubscriber -

clearSubscriber

public void clearSubscriber()

Method clearSubscriber

enumerateSubscriber

public java.util.Enumeration enumerateSubscriber()

Method enumerateSubscriber

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:

the value of field 'name'.

getSubscriber

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

Method getSubscriber

Parameters:

index -

getSubscriber

public Subscriber[] getSubscriber()

Method getSubscriber

getSubscriberCount

public int getSubscriberCount()

Method getSubscriberCount

isValid

public boolean isValid()

Method isValid

marshal

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

Method marshal

Parameters:

out -

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 -

removeSubscriber

public boolean removeSubscriber(Subscriber vSubscriber)

Method removeSubscriber

Parameters:

vSubscriber -

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 -

setSubscriber

public void setSubscriber(Subscriber[] subscriberArray)

Method setSubscriber

Parameters:

subscriberArray -

unmarshal

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

Method unmarshal

Parameters:

reader -

validate

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

Method validate