com.wandrell.tabletop.dice.notation.DiceNotationExpression 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;

/**
 * A dice notation expression.
 * 

 * Dice notation expressions are meant to generate a value. Note that this value
 * may be generated at random, and as such it can be different each time it is
 * acquired.
 * 

 * It is also possible getting the string representation of the dice notation
 * expression it represents.
 * 
 * @author Bernardo Martínez Garrido
 */
public interface DiceNotationExpression {

    /**
     * Returns the expression as a string.
     * 

     * This will be the dice expression as it is written, for example "2+1d6".
     * 
     * @return the expression as a string
     */
    public String getExpression();

    /**
     * Returns the integer value of the expression.
     * 
     * As the dice notation expressions are meant to generate random values, the
     * result of this methods may be different each time it is acquired.
     * 
     * @return the integer value of the expression
     */
    public Integer getValue();

}