← Back to branch summary

~ubuntu-branches/ubuntu/trusty/cdk/trusty-proposed

« back to all changes in this revision

Viewing changes to src/org/openscience/cdk/interfaces/IMoleculeSet.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/interfaces/IMoleculeSet.java
 
1
/* $RCSfile$
 
2
 * $Author: egonw $
 
3
 * $Date: 2007-02-16 13:56:34 +0100 (Fri, 16 Feb 2007) $
 
4
 * $Revision: 7957 $
 
5
 *
 
6
 * Copyright (C) 2006-2007  Egon Willighagen <egonw@users.sf.net>
 
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
 *
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
 * GNU Lesser General Public License for more details.
 
19
 *
 
20
 * You should have received a copy of the GNU Lesser General Public License
 
21
 * along with this program; if not, write to the Free Software
 
22
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
23
 */
 
24
package org.openscience.cdk.interfaces;
 
25
 
 
26
/**
 
27
 * Represents a set of Molecules.
 
28
 * 
 
29
 * @cdk.module  interfaces
 
30
 * @author      egonw
 
31
 * @cdk.created 2005-08-25
 
32
 */
 
33
public interface IMoleculeSet extends IAtomContainerSet {
 
34
 
 
35
    /**
 
36
     * Adds an IMolecule to this container.
 
37
     *
 
38
     * @param  molecule  The molecule to be added to this container 
 
39
     */
 
40
    public void addMolecule(IMolecule molecule);
 
41
    
 
42
    /**
 
43
     * Adds all molecules in the MoleculeSet to this container.
 
44
     *
 
45
     * @param  moleculeSet  The MoleculeSet to add
 
46
     */
 
47
    public void add(IMoleculeSet moleculeSet);
 
48
    
 
49
    /**
 
50
     * Sets the molecules in the IMoleculeSet, removing previously added
 
51
     * IMolecule's.
 
52
     * 
 
53
     * @param molecules New set of molecules
 
54
     * @see             #molecules()
 
55
     */
 
56
    public void setMolecules(IMolecule[] molecules);
 
57
    
 
58
    /**
 
59
     * Returns the array of Molecules of this container.
 
60
     *
 
61
     * @return    The array of Molecules of this container 
 
62
     * @see       #setMolecules(IMolecule[])
 
63
     */
 
64
    public java.util.Iterator molecules();
 
65
    
 
66
    /**
 
67
     * Returns the Molecule at position <code>number</code> in the
 
68
     * container.
 
69
     *
 
70
     * @param  number  The position of the Molecule to be returned. 
 
71
     * @return         The Molecule at position <code>number</code> . 
 
72
     */
 
73
    public IMolecule getMolecule(int number);
 
74
    
 
75
    
 
76
    /**
 
77
     * Returns the number of Molecules in this Container.
 
78
     *
 
79
     * @return     The number of Molecules in this Container
 
80
     */
 
81
    public int getMoleculeCount();
 
82
        
 
83
}
 
84