PageData


1   /*
2    * Copyright (c) 2005, Rob Gordon.
3    */
4   package org.oddjob.doclet;
5   
6   import java.util.ArrayList  ;
7   import java.util.List  ;
8   
9   
10  /**
11   * Collect all the data required to write a manual page together in one
12   * place.
13   * 
14   * @author Rob Gordon.
15   */
16  public class PageData {
17  
18      /** The tag name */
19      private final String   name;
20      
21      /** The relative path to the directory where
22       * this page should be written.
23       */
24      private final String   fileName;
25      
26      private String   firstSentence;
27      
28      /** The description */
29      private String   description;
30      
31      /** Exmples as Strings */
32      private final List   examples = new ArrayList  ();
33      
34      /** Attributes as Property objects */
35      private final List   attributes = new ArrayList  ();
36      
37      /** Elements as Property objects */
38      private final List   elements = new ArrayList  ();
39      
40      /**
41       * Constructor.
42       * 
43       * @param name The tag name.
44       */
45      public PageData(String   name, String   filename) {
46          this.name = name;
47          this.fileName = filename;
48      }
49  
50      /**
51       * Get the short (xml tag) name for this page data.
52       *  
53       * @return The short name.
54       */
55      public String   getName() {
56          return name;
57      }
58      
59      public void setFirstSentence(String   firstSentence) {
60          this.firstSentence = firstSentence;
61      }
62      
63      public String   getFirstSentence() {
64          return firstSentence;
65      }
66      
67      public void setDescription(String   description) {
68          this.description = description;
69      }
70      
71      public String   getDescription() {
72          return description;
73      }
74      
75      public void addAttribute(Property attribute) {
76          attributes.add(attribute);
77      }
78      
79      public List   getAttributes() {
80          return attributes;
81      }
82      
83      public void addElement(Property element) {
84          elements.add(element);
85      }
86      
87      public List   getElements() {
88          return elements;
89      }
90      
91      public void addExample(String   example) {
92          examples.add(example);
93      }
94      
95      public List   getExamples() {
96          return examples;
97      }
98      /**
99       * @return Returns the file name.
100      */
101     public String   getFileName() {
102         return fileName;
103     }
104 }
105 
106
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags