View Javadoc

1   /*
2    * Copyright 2005 Jukka Zitting <jz@yukatan.fi>
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  package net.sf.exorcist.api;
17  
18  /***
19   * Exporter plugin interface. This is the interface implemented by
20   * the Exorcist exporter plugins. Exporter plugins are used to extract
21   * content from a source content repository and populate the
22   * {@link ContentState ContentState} instance with the exported content.
23   */
24  public interface ContentExporter {
25  
26      /***
27       * Exports content from a source content repository. The exported
28       * content is used to populate the content state instance passed by
29       * the Exorcist framework as the argument.
30       *
31       * @param state the content state snapshot to be populated
32       * @throws ContentException if the selected content could not be exported
33       */
34      void exportContent(ContentState state) throws ContentException;
35  
36  }