////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 the original author or authors.
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.checks.blocks;

/**
 * Represents the options for placing the right curly brace <code>'}'</code>.
 *
 * @author Oliver Burn
 */
public enum RightCurlyOption {

    /**
     * Represents the policy that the brace must be alone on the line
     * and allows single-line format of block.
     * For example:
     *
     * <pre>
     * //Brace is alone on the line
     * try {
     * ...
     * }
     * inally {
     *
     * // Single-line format of block
     * private int foo() { return 1; }
     * </pre>
     **/
    ALONE_OR_SINGLELINE,

    /**
     * Represents the policy that the brace must be alone on the line.
     * For example:
     *
     * <pre>
     * try {
     *     ...
     * }
     * finally {
     * </pre>
     **/
    ALONE,

    /**
     * Represents the policy that the brace must be on the same line as the
     * next statement. For example:
     *
     * <pre>
     * try {
     *     ...
     * } finally {
     * </pre>
     **/
    SAME
}
