org.opennms.reporting.availability

Class Week

java.lang.Object

org.opennms.reporting.availability.Week

All Implemented Interfaces:

Serializable

public class Week
extends Object
implements Serializable

Class Week.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Week()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDay(Day vDay)
void	addDay(int index, Day vDay)
Enumeration<Day>	enumerateDay() Method enumerateDay.
Day[]	getDay() Method getDay.Returns the contents of the collection in an Array.
Day	getDay(int index) Method getDay.
List<Day>	getDayCollection() Method getDayCollection.Returns a reference to '_dayList'.
int	getDayCount() Method getDayCount.
boolean	isValid() Method isValid.
Iterator<Day>	iterateDay() Method iterateDay.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDay()
boolean	removeDay(Day vDay) Method removeDay.
Day	removeDayAt(int index) Method removeDayAt.
void	setDay(Day[] vDayArray)
void	setDay(int index, Day vDay)
void	setDay(List<Day> vDayList) Sets the value of '_dayList' by copying the given Vector.
void	setDayCollection(List<Day> dayList) Deprecated.
static Week	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Week

public Week()

Method Detail

addDay

public void addDay(Day vDay)
            throws IndexOutOfBoundsException

Parameters:

vDay -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addDay

public void addDay(int index,
          Day vDay)
            throws IndexOutOfBoundsException

Parameters:

index -

vDay -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateDay

public Enumeration<Day> enumerateDay()

Method enumerateDay.

Returns:

an Enumeration over all possible elements of this collection

getDay

public Day getDay(int index)
           throws IndexOutOfBoundsException

Method getDay.

Parameters:

index -

Returns:

the value of the org.opennms.reporting.availability.Day at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getDay

public Day[] getDay()

Method getDay.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getDayCollection

public List<Day> getDayCollection()

Method getDayCollection.Returns a reference to '_dayList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getDayCount

public int getDayCount()

Method getDayCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateDay

public Iterator<Day> iterateDay()

Method iterateDay.

Returns:

an Iterator over all possible elements in this collection

marshal

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

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

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

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllDay

public void removeAllDay()

removeDay

public boolean removeDay(Day vDay)

Method removeDay.

Parameters:

vDay -

Returns:

true if the object was removed from the collection.

removeDayAt

public Day removeDayAt(int index)

Method removeDayAt.

Parameters:

index -

Returns:

the element removed from the collection

setDay

public void setDay(int index,
          Day vDay)
            throws IndexOutOfBoundsException

Parameters:

index -

vDay -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setDay

public void setDay(Day[] vDayArray)

Parameters:

vDayArray -

setDay

public void setDay(List<Day> vDayList)

Sets the value of '_dayList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vDayList - the Vector to copy.

setDayCollection

public void setDayCollection(List<Day> dayList)

Deprecated.

Sets the value of '_dayList' by setting it to the given Vector. No type checking is performed.

Parameters:

dayList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.reporting.availability.Week

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

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

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema