View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/maven-dsd-plugin/src/main/java/org/melati/poem/prepro/DescriptionFieldQualifier.java,v $
3    * $Revision: 1.9 $
4    *
5    * Copyright (C) 2000 William Chesters
6    *
7    * Part of Melati (http://melati.org), a framework for the rapid
8    * development of clean, maintainable web applications.
9    *
10   * Melati is free software; Permission is granted to copy, distribute
11   * and/or modify this software under the terms either:
12   *
13   * a) the GNU General Public License as published by the Free Software
14   *    Foundation; either version 2 of the License, or (at your option)
15   *    any later version,
16   *
17   *    or
18   *
19   * b) any version of the Melati Software License, as published
20   *    at http://melati.org
21   *
22   * You should have received a copy of the GNU General Public License and
23   * the Melati Software License along with this program;
24   * if not, write to the Free Software Foundation, Inc.,
25   * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26   * GNU General Public License and visit http://melati.org to obtain the
27   * Melati Software License.
28   *
29   * Feel free to contact the Developers of Melati (http://melati.org),
30   * if you would like to work out a different arrangement than the options
31   * outlined here.  It is our intention to allow Melati to be used by as
32   * wide an audience as possible.
33   *
34   * This program is distributed in the hope that it will be useful,
35   * but WITHOUT ANY WARRANTY; without even the implied warranty of
36   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37   * GNU General Public License for more details.
38   *
39   * Contact details for copyright holder:
40   *
41   *     William Chesters <williamc@paneris.org>
42   *     http://paneris.org/~williamc
43   *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44   */
45  
46  package org.melati.poem.prepro;
47  
48  import java.io.StreamTokenizer;
49  import java.io.IOException;
50  
51  /**
52   * A <tt>FieldQualifier</tt> which defines the <tt>Description</tt> 
53   * of a <tt>Field</tt>.
54   * 
55   */
56  public class DescriptionFieldQualifier extends FieldQualifier {
57  
58    private String description;
59  
60   /**
61    * Constructor.
62    *
63    * @param tokens the <code>StreamTokenizer</code> to get tokens from
64    *
65    * @throws ParsingDSDException if an unexpected token is encountered
66    * @throws IOException if something goes wrong with the file system
67    */
68    public DescriptionFieldQualifier(StreamTokenizer tokens)
69        throws ParsingDSDException, IOException {
70      DSD.expect(tokens, '=');
71      if (tokens.nextToken() != '"')
72        throw new ParsingDSDException("<description string>", tokens);
73      description = tokens.sval;
74      tokens.nextToken();
75    }
76  
77   /**
78    * Update the model.
79    *
80    * @param field the {@link FieldDef} to update
81    */
82    public void apply(FieldDef field) {
83      field.description = description;
84    }
85  }