Top Fields Constructors Methods
org.apache.sshd.scp.common.helpers

public abstract Class ScpPathCommandDetailsSupport

extends AbstractScpCommandDetails
implements NamedResource
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.NamedResource
Known Direct Subclasses
org.apache.sshd.scp.common.helpers.ScpReceiveDirCommandDetails, org.apache.sshd.scp.common.helpers.ScpReceiveFileCommandDetails
Annotations
@SuppressWarnings:PMD.AvoidUsingOctalValues
Imports
java.nio.file.attribute.PosixFilePermission, java.util.Collection, .EnumSet, .Objects, .Set, org.apache.sshd.common.NamedResource, org.apache.sshd.common.util.GenericUtils, .ValidateUtils

Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private long
private String
private Set<PosixFilePermission>
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
Inherited from org.apache.sshd.scp.common.helpers.AbstractScpCommandDetails:
command

Constructor Summary

AccessConstructor and Description
protected
protected
ScpPathCommandDetailsSupport(char command, String header)

Method Summary

Modifier and TypeMethod and Description
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.

protected long
public long
public String
public static String
public Set<PosixFilePermission>
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static Set<PosixFilePermission>
public void
setLength(long length)

public void
public void
public String
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.apache.sshd.scp.common.helpers.AbstractScpCommandDetails:
getCommand

Field Detail

lengthback to summary
private long length
nameback to summary
private String name
permissionsback to summary
private Set<PosixFilePermission> permissions
S_IRGRPback to summary
public static final int S_IRGRP
S_IROTHback to summary
public static final int S_IROTH
S_IRUSRback to summary
public static final int S_IRUSR
S_IWGRPback to summary
public static final int S_IWGRP
S_IWOTHback to summary
public static final int S_IWOTH
S_IWUSRback to summary
public static final int S_IWUSR
S_IXGRPback to summary
public static final int S_IXGRP
S_IXOTHback to summary
public static final int S_IXOTH
S_IXUSRback to summary
public static final int S_IXUSR

Constructor Detail

ScpPathCommandDetailsSupportback to summary
protected ScpPathCommandDetailsSupport(char command)
ScpPathCommandDetailsSupportback to summary
protected ScpPathCommandDetailsSupport(char command, String header)

Method Detail

equalsback 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
getEffectiveLengthback to summary
protected long getEffectiveLength()
getLengthback to summary
public long getLength()
getNameback to summary
public String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations
@Override
getOctalPermissionsback to summary
public static String getOctalPermissions(Collection<PosixFilePermission> perms)
getPermissionsback to summary
public Set<PosixFilePermission> getPermissions()
hashCodeback 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
parseOctalPermissionsback to summary
public static Set<PosixFilePermission> parseOctalPermissions(String str)
setLengthback to summary
public void setLength(long length)
setNameback to summary
public void setName(String name)
setPermissionsback to summary
public void setPermissions(Set<PosixFilePermission> permissions)
toHeaderback to summary
public String toHeader()

Implements abstract org.apache.sshd.scp.common.helpers.AbstractScpCommandDetails.toHeader.

Returns:String

Doc from org.apache.sshd.scp.common.helpers.AbstractScpCommandDetails.toHeader.

The equivalent SCP command header represented by these details

Annotations
@Override
toStringback 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