/*
 * Copyright 2015 Google Inc.
 *
 * 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.palantir.javaformat;

import com.google.common.base.MoreObjects;
import com.palantir.javaformat.doc.Doc;
import com.palantir.javaformat.doc.DocBuilder;

/**
 * A {@code CloseOp} closes a level. It is an {@link Op} in the sequence of {@link Op}s generated by {@link OpsBuilder}.
 * When the sequence is turned into a {@link Doc} by {@link DocBuilder}, ranges delimited by
 * {@link OpenOp}-{@code CloseOp} pairs turn into nested {@link Doc.Level}s.
 */
public enum CloseOp implements Op {
    CLOSE;

    /**
     * Make a {@code CloseOp}, returning a singleton since they are all the same.
     *
     * @return the singleton {@code CloseOp}
     */
    public static Op make() {
        return CLOSE;
    }

    @Override
    public void add(DocBuilder builder) {
        builder.close();
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this).toString();
    }
}
