com.barrybecker4.game.common.GameOptions Maven / Gradle / Ivy

/** Copyright by Barry G. Becker, 2000-2011. Licensed under MIT License: http://www.opensource.org/licenses/MIT  */
package com.barrybecker4.game.common;

import java.io.Serializable;


/**
 * Options specified on a per game basis.
 *
 * @author Barry Becker
 */
public abstract class GameOptions implements Serializable {

    private static final long serialVersionUID = 1L;


    protected GameOptions() {}


    /**
     * @return Limit on the number of players allowed to join the game.
     */
    public abstract int getMaxNumPlayers();

    /**
     * Check constraints on options to verify validity.
     * @return  null if no errors, return error messages if constraints violated.
     */
    public String testValidity() {
        return null;
    }
}