com.googlecode.sarasvati.join.CompleteJoinResult 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.Collection;
import java.util.Collections;
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;

/**
 * Represents a complete join result, encapsulating the arc tokens
 * which completed the join.
 *
 * @author Paul Lorenz
 */
public final class CompleteJoinResult implements JoinResult
{
  private final Collection tokens;
  private final List terminatingTokenSets;

  public CompleteJoinResult (final ArcToken token)
  {
    this(Collections.singletonList(token));
  }

  public CompleteJoinResult (final Collection tokens)
  {
    this(tokens, emptyList());
  }

  public CompleteJoinResult (final Collection tokens, final TokenSet terminatingTokenSet)
  {
    this(tokens, Collections.singletonList(terminatingTokenSet));
  }

  public CompleteJoinResult (final Collection tokens, final List terminatingTokenSets)
  {
    this.tokens = tokens;
    this.terminatingTokenSets = terminatingTokenSets;
  }

  // Java type inference isn't good enough for this to be in-line, yet
  private static List emptyList()
  {
    return Collections.emptyList();
  }

  /**
   * @see JoinResult#getArcTokensCompletingJoin()
   */
  @Override
  public Collection getArcTokensCompletingJoin ()
  {
    return tokens;
  }

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

  @Override
  public NodeToken getMergeTarget ()
  {
    throw new IllegalStateException( "getMergeTarget should never be called for a JoinResult with an action of Complete" );
  }

  /**
   * @see com.googlecode.sarasvati.JoinResult#getTerminatingTokenSets()
   */
  @Override
  public List getTerminatingTokenSets()
  {
    return terminatingTokenSets;
  }
}