Modifier and Type	Class and Description
public static class	AclSupportedParser.AclCapabilities The "acl-supported" information as per DRAFT 11 - section 5.4

Modifier and Type	Field and Description
public static final AclSupportedParser	INSTANCE

Access	Constructor and Description
public	AclSupportedParser()

Modifier and Type	Method and Description
public AclSupportedParser.AclCapabilities	parse(byte[] input, int offset, int len) Implements org.apache.sshd.sftp.common.extensions.ExtensionParser.parse.
public AclSupportedParser.AclCapabilities	parse(Buffer buffer)

INSTANCE	back to summary
public static final AclSupportedParser INSTANCE

AclSupportedParser	back to summary
public AclSupportedParser()

parse	back to summary
public AclSupportedParser.AclCapabilities parse(byte[] input, int offset, int len) Implements org.apache.sshd.sftp.common.extensions.ExtensionParser.parse. Annotations @Override

parse	back to summary
public AclSupportedParser.AclCapabilities parse(Buffer buffer)

org.apache.sshd.sftp.common.extensions back to summary

public Class AclSupportedParser.AclCapabilities

Class Inheritance

extends Object
implements Serializable, Cloneable

java.lang.Object
org.apache.sshd.sftp.common.extensions.AclSupportedParser.AclCapabilities

All Implemented Interfaces

java.lang.Cloneable, java.io.Serializable

The "acl-supported" information as per DRAFT 11 - section 5.4

Author: Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	AclSupportedParser.AclCapabilities.LazyAclCapabilityNameHolder

Field Summary

Modifier and Type	Field and Description
private int	capabilities
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	AclCapabilities()
public	AclCapabilities(int capabilities)

Method Summary

Modifier and Type	Method and Description
public AclSupportedParser.AclCapabilities	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static int	constructAclCapabilities(Collection<Integer> maskValues)
public static NavigableSet<String>	decodeAclCapabilities(int mask)
public static Set<Integer>	deconstructAclCapabilities(int mask)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static String	getAclCapabilityName(int aclCapValue)
public static NavigableMap<String, Integer>	getAclCapabilityNamesMap()
public static Integer	Returns: The matching `Integer` value - or `null` if no match found getAclCapabilityValue(String The ACL capability name - may be without the "SSH_ACL_CAP_xxx" prefix. Ignored if `null`/empty name)
public static NavigableMap<Integer, String>	getAclCapabilityValuesMap()
public int	getCapabilities()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setCapabilities(int capabilities)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

capabilities	back to summary
private int capabilities

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

AclCapabilities	back to summary
public AclCapabilities()

AclCapabilities	back to summary
public AclCapabilities(int capabilities)

Method Detail

clone back to summary

clone	back to summary
public AclSupportedParser.AclCapabilities clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:AclSupportedParser.AclCapabilities a clone of this instance. Annotations @Override

public AclSupportedParser.AclCapabilities clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:AclSupportedParser.AclCapabilities

a clone of this instance.

Annotations

@Override

constructAclCapabilities	back to summary
public static int constructAclCapabilities(Collection<Integer> maskValues)

decodeAclCapabilities	back to summary
public static NavigableSet<String> decodeAclCapabilities(int mask)

deconstructAclCapabilities	back to summary
public static Set<Integer> deconstructAclCapabilities(int mask)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAclCapabilityName	back to summary
public static String getAclCapabilityName(int aclCapValue)

getAclCapabilityNamesMap	back to summary
public static NavigableMap<String, Integer> getAclCapabilityNamesMap() Annotations @SuppressWarnings:synthetic-access

getAclCapabilityValue	back to summary
public static Integer getAclCapabilityValue(String name) Parameters name:String The ACL capability name - may be without the "SSH_ACL_CAP_xxx" prefix. Ignored if `null`/empty Returns:Integer The matching `Integer` value - or `null` if no match found

getAclCapabilityValuesMap	back to summary
public static NavigableMap<Integer, String> getAclCapabilityValuesMap() Annotations @SuppressWarnings:synthetic-access

getCapabilities	back to summary
public int getCapabilities()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

setCapabilities	back to summary
public void setCapabilities(int capabilities)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.apache.sshd.sftp.common.extensions back to summary

private final Class AclSupportedParser.AclCapabilities.LazyAclCapabilityNameHolder

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.sftp.common.extensions.AclSupportedParser.AclCapabilities.LazyAclCapabilityNameHolder

Field Summary

Modifier and Type	Field and Description
private static final String	ACL_CAP_NAME_PREFIX
private static final NavigableMap<String, Integer>	ACL_NAMES_MAP
private static final NavigableMap<Integer, String>	ACL_VALUES_MAP

Constructor Summary

Access	Constructor and Description
private	LazyAclCapabilityNameHolder()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ACL_CAP_NAME_PREFIX	back to summary
private static final String ACL_CAP_NAME_PREFIX

ACL_NAMES_MAP	back to summary
private static final NavigableMap<String, Integer> ACL_NAMES_MAP

ACL_VALUES_MAP	back to summary
private static final NavigableMap<Integer, String> ACL_VALUES_MAP

Constructor Detail

LazyAclCapabilityNameHolder	back to summary
private LazyAclCapabilityNameHolder()