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