View Javadoc
1   package org.apache.maven.doxia.module.fml;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import javax.swing.text.html.HTML.Tag;
23  
24  import org.apache.maven.doxia.markup.HtmlMarkup;
25  
26  /**
27   * List of <code>FML</code> markups.
28   * <br/>
29   * FML uses several  {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
30   * as markups and custom tags.
31   *
32   * @author ltheussl
33   * @version $Id: FmlMarkup.java 1633964 2014-10-23 22:01:01Z hboutemy $
34   * @since 1.0
35   */
36  @SuppressWarnings( "checkstyle:interfaceistype" )
37  public interface FmlMarkup
38      extends HtmlMarkup
39  {
40      /** FML namespace: "http://maven.apache.org/FML/1.0.1" */
41      String FML_NAMESPACE = "http://maven.apache.org/FML/1.0.1";
42  
43      /** FML system id: "http://maven.apache.org/xsd/fml-1.0.1.xsd" */
44      String FML_SYSTEM_ID = "http://maven.apache.org/xsd/fml-1.0.1.xsd";
45  
46      // ----------------------------------------------------------------------
47      // Specific Fml tags
48      // ----------------------------------------------------------------------
49  
50      /** Fml tag for <code>faqs</code> */
51      Tag FAQS_TAG = new Tag()
52      {
53          /** {@inheritDoc} */
54          public String toString()
55          {
56              return "faqs";
57          }
58      };
59  
60      /** Fml tag for <code>part</code> */
61      Tag PART_TAG = new Tag()
62      {
63          /** {@inheritDoc} */
64          public String toString()
65          {
66              return "part";
67          }
68      };
69  
70      /** Fml tag for <code>faq</code> */
71      Tag FAQ_TAG = new Tag()
72      {
73          /** {@inheritDoc} */
74          public String toString()
75          {
76              return "faq";
77          }
78      };
79  
80      /** Fml tag for <code>question</code> */
81      Tag QUESTION_TAG = new Tag()
82      {
83          /** {@inheritDoc} */
84          public String toString()
85          {
86              return "question";
87          }
88      };
89  
90      /** Fml tag for <code>answer</code> */
91      Tag ANSWER_TAG = new Tag()
92      {
93          /** {@inheritDoc} */
94          public String toString()
95          {
96              return "answer";
97          }
98      };
99  
100     /** Fml tag for <code>source</code> */
101     Tag SOURCE_TAG = new Tag()
102     {
103         /** {@inheritDoc} */
104         public String toString()
105         {
106             return "source";
107         }
108     };
109 
110     /**
111      * Fml tag for <code>macro</code>
112      * @since 1.1.1
113      */
114     Tag MACRO_TAG = new Tag()
115     {
116         /** {@inheritDoc} */
117         public String toString()
118         {
119             return "macro";
120         }
121     };
122 }