plantuml/src/jcckit/plot/Symbol.java

/*
 * Copyright 2003-2004, Franz-Josef Elmer, All rights reserved
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details
 * (http://www.gnu.org/copyleft/lesser.html).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package jcckit.plot;

import jcckit.graphic.GraphicalElement;

/**
 * Immutable class holding the graphical represention of the symbol and
 * two {@link Hint Hints}.
 * 
 * @author Franz-Josef Elmer
 */
public class Symbol {
  private final GraphicalElement _symbol;
  private final Hint _hintForNextPoint;
  private final Hint _hintForNextCurve;

  /** Creates an instance for the specified symbol and hints. */
  public Symbol(GraphicalElement symbol, Hint hintForNextPoint,
                Hint hintForNextCurve) {
    _symbol = symbol;
    _hintForNextPoint = hintForNextPoint;
    _hintForNextCurve = hintForNextCurve;
  }

  /** Returns the graphical symbol. */
  public GraphicalElement getSymbol() {
    return _symbol;
  }

  /** Returns the hint for the next point. */
  public Hint getHintForNextPoint() {
    return _hintForNextPoint;
  }

  /** Returns the hint for the next curve. */
  public Hint getHintForNextCurve() {
    return _hintForNextCurve;
  }
}