View Javadoc

1   /*
2    * Copyright 2004 Sun Microsystems, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   */
17  package com.sun.syndication.io;
18  
19  import com.sun.syndication.feed.module.ModuleI;
20  import org.jdom.Element;
21  
22  /***
23   * Parses module metadata from a XML node (JDOM element).
24   * <p>
25   * ModuleParser instances must thread safe.
26   * <p>
27   * TODO: explain how developers can plugin their own implementations.
28   * <p>
29   * @author Alejandro Abdelnur
30   *
31   */
32  public interface ModuleParser {
33  
34      /***
35       * Returns the namespace URI this parser handles.
36       * <p>
37       * @return the namespace URI.
38       *
39       */
40      public String getNamespaceUri();
41  
42      /***
43       * Parses the XML node (JDOM element) extracting module information.
44       * <p>
45       * @param element the XML node (JDOM element) to extract module information from.
46       * @return a module instance, <b>null</b> if the element did not have module information.
47       *
48       */
49      public ModuleI parse(Element element);
50  
51  }