com.wandrell.tabletop.dice.notation.operation.BinaryOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dice Show documentation

Utilities for representing and handling dice and dice notation.

There is a newer version: 1.0.4

/**
 * Copyright 2014-2016 the original author or authors
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.wandrell.tabletop.dice.notation.operation;

import com.wandrell.tabletop.dice.notation.DiceNotationExpression;

/**
 * A binary operation from the dice notation.
 * 

 * Binary operation operate on pairs of operands. But it is not required giving
 * these operands directly, instead they can be acquired from other expressions,
 * allowing chaining them.
 * 
 * Depending on the operation, the order of the operands may be important or
 * not.
 * 
 * @author Bernardo Martínez Garrido
 */
public interface BinaryOperation extends DiceNotationExpression {

    /**
     * Returns the left sided operand.
     * 
     * @return the left sided operand
     */
    public DiceNotationExpression getLeft();

    /**
     * Returns the right sided operand.
     * 
     * @return the right sided operand
     */
    public DiceNotationExpression getRight();

}