com.bernardomg.tabletop.dice.package-info 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: 2.2.5

/**
 * Copyright 2015 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.
 */
/**
 * Dice classes, including the model for dice.
 * 
Model
 * 
 * The {@link com.bernardomg.tabletop.dice.Dice Dice} interface, and the default
 * implementation of this, the {@link com.bernardomg.tabletop.dice.DefaultDice
 * DefaultDice}, offer a simple model for dice groups.
 * 
Sub-packages
 * 
 * The packages inside this one extend over the basic dice in various ways.
 * 

 * With the {@link com.bernardomg.tabletop.dice.roller roller} package it is
 * possible generating random values from the dice classes.
 * 

 * For actual dice notation, including operations, the model inside the
 * {@link com.bernardomg.tabletop.dice.notation notation} package can be used.
 * 
 * The {@link com.bernardomg.tabletop.dice.parser parser} package hosts parsers
 * which can transform an expression into an equivalent object.
 */

package com.bernardomg.tabletop.dice;