com.palantir.giraffe.file.base.BasePath 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 java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.WatchEvent.Kind;
import java.nio.file.WatchEvent.Modifier;
import java.nio.file.WatchKey;
import java.nio.file.WatchService;
import java.util.Iterator;
import java.util.NoSuchElementException;

import com.google.common.collect.UnmodifiableIterator;

/**
 * An abstract {@link Path} implementation that works independent of the file
 * system or path representation.
 * 
 * Methods on this class are implemented in terms of other methods defined by
 * {@code Path} or throw {@code UnsupportedOperationException}.
 *
 * @author bkeyes
 *
 * @param 
 the type of the implementing class
 */
public abstract class BasePath
> implements Path {

    @Override
    public abstract BaseFileSystem getFileSystem();

    @Override
    public boolean startsWith(String other) {
        return startsWith(getFileSystem().getPath(other));
    }

    @Override
    public boolean endsWith(String other) {
        return endsWith(getFileSystem().getPath(other));
    }

    @Override
    public Path resolve(String other) {
        return resolve(getFileSystem().getPath(other));
    }

    @Override
    public Path resolveSibling(String other) {
        return resolveSibling(getFileSystem().getPath(other));
    }

    @Override
    public File toFile() {
        throw new UnsupportedOperationException();
    }

    @Override
    public Iterator iterator() {
        return new UnmodifiableIterator() {
            private int i = 0;

            @Override
            public boolean hasNext() {
                return i < getNameCount();
            }

            @Override
            public Path next() {
                if (i < getNameCount()) {
                    Path result = getName(i);
                    i++;
                    return result;
                } else {
                    throw new NoSuchElementException();
                }
            }
        };
    }

    @Override
    public WatchKey register(WatchService watcher, Kind... events) throws IOException {
        return register(watcher, events, new Modifier[0]);
    }

    @Override
    public WatchKey register(WatchService watcher, Kind[] events, Modifier... modifiers)
            throws IOException {
        throw new UnsupportedOperationException();
    }

    @Override
    public abstract int hashCode();

    @Override
    public abstract boolean equals(Object o);

}