com.googlecode.sarasvati.join.IncompleteJoinResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sarasvati-core Show documentation
The newest version!
/*
    This file is part of Sarasvati.

    Sarasvati 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 3 of the
    License, or (at your option) any later version.

    Sarasvati 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.

    You should have received a copy of the GNU Lesser General Public
    License along with Sarasvati.  If not, see .

    Copyright 2009 Paul Lorenz
*/

package com.googlecode.sarasvati.join;

import java.util.List;

import com.googlecode.sarasvati.ArcToken;
import com.googlecode.sarasvati.JoinAction;
import com.googlecode.sarasvati.JoinResult;
import com.googlecode.sarasvati.NodeToken;
import com.googlecode.sarasvati.TokenSet;

public enum IncompleteJoinResult implements JoinResult
{
  INSTANCE;

  /**
   * Always returns {@link JoinAction#Nothing}
   *
   * @see com.googlecode.sarasvati.JoinResult#getJoinAction()
   */
  @Override
  public JoinAction getJoinAction ()
  {
    return JoinAction.Nothing;
  }

  /**
   * Always throws an {@link IllegalStateException}
   * @see JoinResult#getArcTokensCompletingJoin()
   */
  @Override
  public List getArcTokensCompletingJoin ()
  {
    throw new IllegalStateException( "getArcTokensCompletingJoin should never be called for a JoinResult with an action of Nothing" );
  }

  /**
   * Always throws an {@link IllegalStateException}
   *
   * @see com.googlecode.sarasvati.JoinResult#getMergeTarget()
   */
  @Override
  public NodeToken getMergeTarget ()
  {
    throw new IllegalStateException( "getMergeTarget should never be called for a JoinResult with an action of Nothing" );
  }

  /**
   * Always throws an {@link IllegalStateException}
   *
   * @see com.googlecode.sarasvati.JoinResult#getTerminatingTokenSets()
   */
  @Override
  public List getTerminatingTokenSets()
  {
    throw new IllegalStateException( "getTerminatingTokenSets should never be called for a JoinResult with an action of Nothing" );
  }
}