← Back to branch summary

~ubuntu-branches/ubuntu/maverick/cdk/maverick

« back to all changes in this revision

Viewing changes to src/org/openscience/cdk/io/formats/IChemFormat.java

  • Committer: Bazaar Package Importer
  • Author(s): Paul Cager
  • Date: 2008-04-09 21:17:53 UTC
  • Revision ID: james.westby@ubuntu.com-20080409211753-46lmjw5z8mx5pd8d
Tags: upstream-1.0.2
Import upstream version 1.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org/openscience/cdk/io/formats/IChemFormat.java
 
1
/* $RCSfile$
 
2
 * $Author: egonw $
 
3
 * $Date: 2007-02-19 15:17:08 +0100 (Mon, 19 Feb 2007) $  
 
4
 * $Revision: 7979 $
 
5
 *
 
6
 * Copyright (C) 1997-2007  The Chemistry Development Kit (CDK) project
 
7
 *
 
8
 * Contact: cdk-devel@lists.sourceforge.net
 
9
 *
 
10
 * This program is free software; you can redistribute it and/or
 
11
 * modify it under the terms of the GNU Lesser General Public License
 
12
 * as published by the Free Software Foundation; either version 2.1
 
13
 * of the License, or (at your option) any later version.
 
14
 * All we ask is that proper credit is given for our work, which includes
 
15
 * - but is not limited to - adding the above copyright notice to the beginning
 
16
 * of your source code files, and to any copyright notice that you may distribute
 
17
 * with programs based on this work.
 
18
 *
 
19
 * This program is distributed in the hope that it will be useful,
 
20
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
21
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
22
 * GNU Lesser General Public License for more details.
 
23
 *
 
24
 * You should have received a copy of the GNU Lesser General Public License
 
25
 * along with this program; if not, write to the Free Software
 
26
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
27
 */
 
28
package org.openscience.cdk.io.formats;
 
29
 
 
30
/**
 
31
 * This class is the interface that all ChemFormat's should implement.
 
32
 *
 
33
 * @cdk.module io
 
34
 *
 
35
 * @author      Egon Willighagen <egonw@sci.kun.nl>
 
36
 * @cdk.created 2004-10-25
 
37
 * @cdk.bug     1495502
 
38
 */
 
39
public interface IChemFormat extends IResourceFormat {
 
40
 
 
41
    /**
 
42
     * Returns the class name of the CDK Reader for this format.
 
43
     *
 
44
     * @return null if no CDK Reader is available.
 
45
     */
 
46
    public String getReaderClassName();
 
47
 
 
48
    /**
 
49
     * Returns the class name of the CDK Writer for this format.
 
50
     *
 
51
     * @return null if no CDK Writer is available.
 
52
     */
 
53
    public String getWriterClassName();
 
54
    
 
55
    /**
 
56
     * Returns an integer indicating the data features that this 
 
57
     * format supports. The integer is composed as explained in 
 
58
     * DataFeatures. May be set to DataFeatures.NONE as default.
 
59
     * 
 
60
     * @see org.openscience.cdk.tools.DataFeatures
 
61
     */
 
62
    public int getSupportedDataFeatures();
 
63
 
 
64
    /**
 
65
     * Returns an integer indicating the data features that this 
 
66
     * format requires. For example, the XYZ format requires 3D
 
67
     * coordinates.
 
68
     * 
 
69
     * @see org.openscience.cdk.tools.DataFeatures
 
70
     */
 
71
    public int getRequiredDataFeatures();
 
72
}
 
73