org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plexus-io Show documentation

There is a newer version: 3.5.1

package org.codehaus.plexus.components.io.attributes;

/*
 * Copyright 2007 The Codehaus Foundation.
 *
 * 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.
 */

import javax.annotation.Nullable;

public interface PlexusIoResourceAttributes {
    int UNKNOWN_OCTAL_MODE = -1;

    boolean isOwnerReadable();

    boolean isOwnerWritable();

    boolean isOwnerExecutable();

    boolean isGroupReadable();

    boolean isGroupWritable();

    boolean isGroupExecutable();

    boolean isWorldReadable();

    boolean isWorldWritable();

    boolean isWorldExecutable();

    /**
     * Gets the unix user id.
     * @return The unix user id, may be null ("not set"), even on unix
     */
    Integer getUserId();

    /**
     * Gets the unix group id.
     * @return The unix group id, may be null ("not set"), even on unix
     */
    @Nullable
    Integer getGroupId();

    /**
     * Returns the user name of the user owning the file. Probably not null :)
     * @return The user name
     */
    @Nullable
    String getUserName();

    /**
     * The group name. May be null if groups are unsupported
     * @return the group names
     */
    @Nullable
    String getGroupName();

    /**
     * Octal mode attributes.
     * {@link #UNKNOWN_OCTAL_MODE} if unsupported on current file/file system
     */
    int getOctalMode();

    /**
     * Indicates if this is a symbolic link element.
     * For file-based resource attributes this value may be always "false" for versions prior to java7.
     * @return True if the file is a symlink or false if not.
     */
    boolean isSymbolicLink();
}