org.openscience.cdk.iupac.parser

Class AttachedGroup

java.lang.Object

org.openscience.cdk.iupac.parser.AttachedGroup

public class AttachedGroup
extends Object

Holds data on a specific functional group or substituent.

Author:

Stephen Tomkinson

Source code:

master

Requires:

ant1.6

Constructor Summary

Constructors

Constructor and Description
AttachedGroup() Creates a new instance of FunctionalGroup
AttachedGroup(List<Token> locations, int length) Creates a new instance of AttachedGroup with an int denoting the length of the substituent chain
AttachedGroup(List<Token> locations, String name) Creates a new instance of AttachedGroup with a Sting denoting the functional group

Method Summary

Modifier and Type	Method and Description
int	getLength() Getter for property length.
List<Token>	getLocations() Getter for property locations.
String	getName() Getter for property name.
void	setLength(int length) Setter for property length.
void	setLocations(List<Token> locations) Setter for property locations.
void	setName(String name) Setter for property name.
String	toString() A debug string which represents the contents of the class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachedGroup

public AttachedGroup()

Creates a new instance of FunctionalGroup

AttachedGroup

public AttachedGroup(List<Token> locations,
                     String name)

Creates a new instance of AttachedGroup with a Sting denoting the functional group

AttachedGroup

public AttachedGroup(List<Token> locations,
                     int length)

Creates a new instance of AttachedGroup with an int denoting the length of the substituent chain

Method Detail

getName

public String getName()

Getter for property name.

Returns:

Value of property name.

setName

public void setName(String name)

Setter for property name.

Parameters:

name - New value of property name.

getLocations

public List<Token> getLocations()

Getter for property locations.

Returns:

Value of property locations.

setLocations

public void setLocations(List<Token> locations)

Setter for property locations.

Parameters:

locations - New value of property locations.

toString

public String toString()

A debug string which represents the contents of the class.

Overrides:

toString in class Object

getLength

public int getLength()

Getter for property length.

Returns:

Value of property length.

setLength

public void setLength(int length)

Setter for property length.

Parameters:

length - New value of property length.