com.helger.commons.io.EAppend Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.commons.io;

import java.nio.file.OpenOption;
import java.nio.file.StandardOpenOption;
import java.util.function.BooleanSupplier;

import javax.annotation.Nonnull;

/**
 * Small enum for determining the append or truncate state of output streams.
 *
 * @author Philip Helger
 */
public enum EAppend implements BooleanSupplier
{
  /** Append to an existing object */
  APPEND,
  /** Truncate an eventually existing object and start over */
  TRUNCATE;

  /** The default is {@link #TRUNCATE} */
  @Nonnull
  public static final EAppend DEFAULT = TRUNCATE;

  public boolean getAsBoolean ()
  {
    return isAppend ();
  }

  public boolean isAppend ()
  {
    return this == APPEND;
  }

  public boolean isTruncate ()
  {
    return this == TRUNCATE;
  }

  @Nonnull
  public OpenOption [] getAsOpenOptions ()
  {
    return this == APPEND ? new OpenOption [] { StandardOpenOption.CREATE, StandardOpenOption.APPEND }
                          : new OpenOption [] { StandardOpenOption.CREATE };
  }
}