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  
18  package com.sun.syndication.feed.module;
19  
20  import java.util.List;
21  
22  /**
23   * Objects that can have modules are Extendable.
24   * @author Dave Johnson
25   */
26  public interface Extendable {
27      
28      /**
29       * Returns the module identified by a given URI.
30       * <p>
31       * @param uri the URI of the ModuleImpl.
32       * @return The module with the given URI, <b>null</b> if none.
33       */
34      public Module getModule(String uri);
35  
36      /**
37       * Returns the entry modules.
38       * <p>
39       * @return a list of ModuleImpl elements with the entry modules,
40       *         an empty list if none.
41       *
42       */
43      List getModules();
44  
45      /**
46       * Sets the entry modules.
47       * <p>
48       * @param modules the list of ModuleImpl elements with the entry modules to set,
49       *        an empty list or <b>null</b> if none.
50       *
51       */
52      void setModules(List modules);
53  }