current/sdk/sdk_library/public/art.module.public.api_stub_sources/java/nio/file/attribute/AclEntry.java

/*
 * Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


package java.nio.file.attribute;

import java.util.*;

/**
 * An entry in an access control list (ACL).
 *
 * <p> The ACL entry represented by this class is based on the ACL model
 * specified in <a href="http://www.ietf.org/rfc/rfc3530.txt"><i>RFC&nbsp;3530:
 * Network File System (NFS) version 4 Protocol</i></a>. Each entry has four
 * components as follows:
 *
 * <ol>
 *    <li><p> The {@link #type() type} component determines if the entry
 *    grants or denies access. </p></li>
 *
 *    <li><p> The {@link #principal() principal} component, sometimes called the
 *    "who" component, is a {@link java.nio.file.attribute.UserPrincipal UserPrincipal} corresponding to the identity
 *    that the entry grants or denies access
 *    </p></li>
 *
 *    <li><p> The {@link #permissions permissions} component is a set of
 *    {@link java.nio.file.attribute.AclEntryPermission AclEntryPermission}
 *    </p></li>
 *
 *    <li><p> The {@link #flags flags} component is a set of {@link java.nio.file.attribute.AclEntryFlag AclEntryFlag} to indicate how entries are inherited and propagated </p></li>
 * </ol>
 *
 * <p> ACL entries are created using an associated {@link java.nio.file.attribute.AclEntry.Builder Builder} object by
 * invoking its {@link java.nio.file.attribute.AclEntry.Builder#build Builder#build} method.
 *
 * <p> ACL entries are immutable and are safe for use by multiple concurrent
 * threads.
 *
 * @since 1.7
 */

@SuppressWarnings({"unchecked", "deprecation", "all"})
public final class AclEntry {

private AclEntry() { throw new RuntimeException("Stub!"); }

/**
 * Constructs a new builder. The initial value of the type and who
 * components is {@code null}. The initial value of the permissions and
 * flags components is the empty set.
 *
 * @return  a new builder
 */

public static java.nio.file.attribute.AclEntry.Builder newBuilder() { throw new RuntimeException("Stub!"); }

/**
 * Constructs a new builder with the components of an existing ACL entry.
 *
 * @param   entry  an ACL entry
 * @return  a new builder
 */

public static java.nio.file.attribute.AclEntry.Builder newBuilder(java.nio.file.attribute.AclEntry entry) { throw new RuntimeException("Stub!"); }

/**
 * Returns the ACL entry type.
 *
 * @return the ACL entry type
 */

public java.nio.file.attribute.AclEntryType type() { throw new RuntimeException("Stub!"); }

/**
 * Returns the principal component.
 *
 * @return the principal component
 */

public java.nio.file.attribute.UserPrincipal principal() { throw new RuntimeException("Stub!"); }

/**
 * Returns a copy of the permissions component.
 *
 * <p> The returned set is a modifiable copy of the permissions.
 *
 * @return the permissions component
 */

public java.util.Set<java.nio.file.attribute.AclEntryPermission> permissions() { throw new RuntimeException("Stub!"); }

/**
 * Returns a copy of the flags component.
 *
 * <p> The returned set is a modifiable copy of the flags.
 *
 * @return the flags component
 */

public java.util.Set<java.nio.file.attribute.AclEntryFlag> flags() { throw new RuntimeException("Stub!"); }

/**
 * Compares the specified object with this ACL entry for equality.
 *
 * <p> If the given object is not an {@code AclEntry} then this method
 * immediately returns {@code false}.
 *
 * <p> For two ACL entries to be considered equals requires that they are
 * both the same type, their who components are equal, their permissions
 * components are equal, and their flags components are equal.
 *
 * <p> This method satisfies the general contract of the {@link
 * java.lang.Object#equals(Object) Object.equals} method. </p>
 *
 * @param   ob   the object to which this object is to be compared
 *
 * @return  {@code true} if, and only if, the given object is an AclEntry that
 *          is identical to this AclEntry
 */

public boolean equals(java.lang.Object ob) { throw new RuntimeException("Stub!"); }

/**
 * Returns the hash-code value for this ACL entry.
 *
 * <p> This method satisfies the general contract of the {@link java.lang.Object#hashCode Object#hashCode} method.
 */

public int hashCode() { throw new RuntimeException("Stub!"); }

/**
 * Returns the string representation of this ACL entry.
 *
 * @return  the string representation of this entry
 */

public java.lang.String toString() { throw new RuntimeException("Stub!"); }
/**
 * A builder of {@link java.nio.file.attribute.AclEntry AclEntry} objects.
 *
 * <p> A {@code Builder} object is obtained by invoking one of the {@link java.nio.file.attribute.AclEntry#newBuilder AclEntry#newBuilder} methods defined by the {@code AclEntry}
 * class.
 *
 * <p> Builder objects are mutable and are not safe for use by multiple
 * concurrent threads without appropriate synchronization.
 *
 * @since 1.7
 */

@SuppressWarnings({"unchecked", "deprecation", "all"})
public static final class Builder {

private Builder() { throw new RuntimeException("Stub!"); }

/**
 * Constructs an {@link java.nio.file.attribute.AclEntry AclEntry} from the components of this builder.
 * The type and who components are required to have been set in order
 * to construct an {@code AclEntry}.
 *
 * @return  a new ACL entry
 *
 * @throws  java.lang.IllegalStateException
 *          if the type or who component have not been set
 */

public java.nio.file.attribute.AclEntry build() { throw new RuntimeException("Stub!"); }

/**
 * Sets the type component of this builder.
 *
 * @param   type  the component type
 * @return  this builder
 */

public java.nio.file.attribute.AclEntry.Builder setType(java.nio.file.attribute.AclEntryType type) { throw new RuntimeException("Stub!"); }

/**
 * Sets the principal component of this builder.
 *
 * @param   who  the principal component
 * @return  this builder
 */

public java.nio.file.attribute.AclEntry.Builder setPrincipal(java.nio.file.attribute.UserPrincipal who) { throw new RuntimeException("Stub!"); }

/**
 * Sets the permissions component of this builder. On return, the
 * permissions component of this builder is a copy of the given set.
 *
 * @param   perms  the permissions component
 * @return  this builder
 *
 * @throws  java.lang.ClassCastException
 *          if the set contains elements that are not of type {@code
 *          AclEntryPermission}
 */

public java.nio.file.attribute.AclEntry.Builder setPermissions(java.util.Set<java.nio.file.attribute.AclEntryPermission> perms) { throw new RuntimeException("Stub!"); }

/**
 * Sets the permissions component of this builder. On return, the
 * permissions component of this builder is a copy of the permissions in
 * the given array.
 *
 * @param   perms  the permissions component
 * @return  this builder
 */

public java.nio.file.attribute.AclEntry.Builder setPermissions(java.nio.file.attribute.AclEntryPermission... perms) { throw new RuntimeException("Stub!"); }

/**
 * Sets the flags component of this builder. On return, the flags
 * component of this builder is a copy of the given set.
 *
 * @param   flags  the flags component
 * @return  this builder
 *
 * @throws  java.lang.ClassCastException
 *          if the set contains elements that are not of type {@code
 *          AclEntryFlag}
 */

public java.nio.file.attribute.AclEntry.Builder setFlags(java.util.Set<java.nio.file.attribute.AclEntryFlag> flags) { throw new RuntimeException("Stub!"); }

/**
 * Sets the flags component of this builder. On return, the flags
 * component of this builder is a copy of the flags in the given
 * array.
 *
 * @param   flags  the flags component
 * @return  this builder
 */

public java.nio.file.attribute.AclEntry.Builder setFlags(java.nio.file.attribute.AclEntryFlag... flags) { throw new RuntimeException("Stub!"); }
}

}