com.palantir.giraffe.file.base.CopyFlags Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of giraffe-fs-base Show documentation
Palantir open source project
There is a newer version: 0.10.1
/**
 * Copyright 2015 Palantir Technologies, 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.giraffe.file.base;

import static com.google.common.base.Preconditions.checkNotNull;

import java.nio.file.CopyOption;
import java.nio.file.LinkOption;
import java.nio.file.StandardCopyOption;
import java.util.Arrays;

/**
 * Container for standard {@link CopyOption}s.
 * 
 * This class may be extended by file system implementations that add custom
 * options. Use {@link #setStandardOption(CopyFlags, CopyOption)} to set
 * standard options in custom subclasses.
 *
 * @author bkeyes
 *
 * @see StandardCopyOption
 * @see LinkOption
 */
public class CopyFlags {

    public boolean replaceExisting = false;
    public boolean copyAttributes = false;
    public boolean atomicMove = false;
    public boolean followLinks = true;

    public static CopyFlags fromOptions(CopyOption... options) {
        return fromOptions(Arrays.asList(options));
    }

    public static CopyFlags fromOptions(Iterable options) {
        CopyFlags flags = new CopyFlags();
        for (CopyOption option : options) {
            if (!setStandardOption(flags, option)) {
                throw new UnsupportedOperationException("unknown option: " + option);
            }
        }
        return flags;
    }

    /**
     * Sets a standard option in {@code flags}.
     *
     * @param flags the flags object in which to set the option
     * @param option the standard option to set
     *
     * @return {@code true} if the option was recognized and set or
     *         {@code false} if the option was non-standard.
     */
    protected static boolean setStandardOption(CopyFlags flags, CopyOption option) {
        if (checkNotNull(option) instanceof StandardCopyOption) {
            setStandardCopyOption(flags, (StandardCopyOption) option);
            return true;
        } else if (option == LinkOption.NOFOLLOW_LINKS) {
            flags.followLinks = false;
            return true;
        } else {
            return false;
        }
    }

    private static void setStandardCopyOption(CopyFlags flags, StandardCopyOption option) {
        switch (option) {
            case ATOMIC_MOVE:
                flags.atomicMove = true;
                break;
            case COPY_ATTRIBUTES:
                flags.copyAttributes = true;
                break;
            case REPLACE_EXISTING:
                flags.replaceExisting = true;
                break;
        }
    }
}