001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022
023package org.biojava.bio.symbol;
024
025import java.io.Serializable;
026import java.util.Collections;
027import java.util.List;
028
029import org.biojava.bio.Annotation;
030
031/**
032 * An atomic symbol consisting only of itself.  This is the
033 * fundamental type of symbol, and needs a special implementation.
034 *
035 * If you wish to construct new Symbols, you should normally do so via utility methods
036 * on <code>AlphabetManager</code>.
037 *
038 * This may be useful as a base-class for other <code>Symbol</code> implementations.
039 *
040 * @author Thomas Down
041 * @since 1.1
042 */
043
044public class FundamentalAtomicSymbol extends AbstractSymbol implements AtomicSymbol, Serializable {
045    private final String name;
046    private final Annotation annotation;
047
048    public FundamentalAtomicSymbol(
049        String name,
050        Annotation annotation)
051    {
052        this.name = name;
053        this.annotation = annotation;
054    }
055
056    public String getName() {
057        return name;
058    }
059
060    public Alphabet getMatches() {
061        return new SingletonAlphabet(this);
062    }
063
064    public List getSymbols() {
065        return Collections.nCopies(1, this);
066    }
067
068    public Annotation getAnnotation() {
069        return annotation;
070    }
071}