bcdd5747d5a07f407178b9751b18b69e6084b207
[jalview.git] / src / jalview / binding / Sequence.java
1 /*******************************************************************************
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $(date) The Jalview Authors
4  *
5  * This file is part of Jalview.
6  *  
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *   
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  *******************************************************************************/
21 /*
22  * This class was automatically generated with 
23  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
24  * Schema.
25  * $Id$
26  */
27
28 package jalview.binding;
29
30 //---------------------------------/
31 //- Imported classes and packages -/
32 //---------------------------------/
33
34 import org.exolab.castor.xml.Marshaller;
35 import org.exolab.castor.xml.Unmarshaller;
36
37 /**
38  * Class Sequence.
39  * 
40  * @version $Revision$ $Date$
41  */
42 public class Sequence extends SequenceType implements java.io.Serializable
43 {
44
45   // ----------------/
46   // - Constructors -/
47   // ----------------/
48
49   public Sequence()
50   {
51     super();
52   }
53
54   // -----------/
55   // - Methods -/
56   // -----------/
57
58   /**
59    * Method isValid.
60    * 
61    * @return true if this object is valid according to the schema
62    */
63   public boolean isValid()
64   {
65     try
66     {
67       validate();
68     } catch (org.exolab.castor.xml.ValidationException vex)
69     {
70       return false;
71     }
72     return true;
73   }
74
75   /**
76    * 
77    * 
78    * @param out
79    * @throws org.exolab.castor.xml.MarshalException
80    *           if object is null or if any SAXException is thrown during
81    *           marshaling
82    * @throws org.exolab.castor.xml.ValidationException
83    *           if this object is an invalid instance according to the schema
84    */
85   public void marshal(final java.io.Writer out)
86           throws org.exolab.castor.xml.MarshalException,
87           org.exolab.castor.xml.ValidationException
88   {
89     Marshaller.marshal(this, out);
90   }
91
92   /**
93    * 
94    * 
95    * @param handler
96    * @throws java.io.IOException
97    *           if an IOException occurs during marshaling
98    * @throws org.exolab.castor.xml.ValidationException
99    *           if this object is an invalid instance according to the schema
100    * @throws org.exolab.castor.xml.MarshalException
101    *           if object is null or if any SAXException is thrown during
102    *           marshaling
103    */
104   public void marshal(final org.xml.sax.ContentHandler handler)
105           throws java.io.IOException,
106           org.exolab.castor.xml.MarshalException,
107           org.exolab.castor.xml.ValidationException
108   {
109     Marshaller.marshal(this, handler);
110   }
111
112   /**
113    * Method unmarshal.
114    * 
115    * @param reader
116    * @throws org.exolab.castor.xml.MarshalException
117    *           if object is null or if any SAXException is thrown during
118    *           marshaling
119    * @throws org.exolab.castor.xml.ValidationException
120    *           if this object is an invalid instance according to the schema
121    * @return the unmarshaled jalview.binding.SequenceType
122    */
123   public static jalview.binding.SequenceType unmarshal(
124           final java.io.Reader reader)
125           throws org.exolab.castor.xml.MarshalException,
126           org.exolab.castor.xml.ValidationException
127   {
128     return (jalview.binding.SequenceType) Unmarshaller
129             .unmarshal(jalview.binding.Sequence.class, reader);
130   }
131
132   /**
133    * 
134    * 
135    * @throws org.exolab.castor.xml.ValidationException
136    *           if this object is an invalid instance according to the schema
137    */
138   public void validate() throws org.exolab.castor.xml.ValidationException
139   {
140     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
141     validator.validate(this);
142   }
143
144 }