com.novell.admin.ns

Interface NSFileObject

public interface NSFileObject

Defines an entry that represents a File or Directory

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_DIRECTORY Type of this file object is a DIRECTORY.
static int	TYPE_FILE Type of this file object is a FILE.
static int	TYPE_NOTEXIST This File Object does not exist.
static int	TYPE_UNSPECIFIED Type of this file object has not been specified.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getDirNameBaseNameBackslashed() Gets dirname and basename of this file or directory with backslashes
java.lang.String[]	getDirNameBaseNameForwardslashed() Gets dirname and basename of this file or directory with forwardslashes
java.lang.String	getName() Gets name of this file or directory
java.lang.String	getNameBackslashed() Gets name of this file or directory with backslashes
java.lang.String	getNameForwardslashed() Gets name of this file or directory with forwardslashes
NSFileTrustee[]	getTrustees() Get the NSFileTrustee(s) associated with this file object.
int	getType() Get the type of this file object
boolean	isJunctionFile() Get a boolean indicating if this object is a Junction file

Field Detail

TYPE_UNSPECIFIED

static final int TYPE_UNSPECIFIED

Type of this file object has not been specified. File object may or may not exist on the file system. It has not been determined yet.

See Also:

Constant Field Values

TYPE_FILE

static final int TYPE_FILE

Type of this file object is a FILE. FILE may or may not exist. Used when creating a new object (it does not exist yet) or returned from some API calls.

See Also:

Constant Field Values

TYPE_DIRECTORY

static final int TYPE_DIRECTORY

Type of this file object is a DIRECTORY. DIRECTORY may or may not exist. Used when creating a new object (does not exist yet) or returned from some API calls.

See Also:

Constant Field Values

TYPE_NOTEXIST

static final int TYPE_NOTEXIST

This File Object does not exist. This is a returned value from API calls. An API call was made and the specified name does not exist on the file system.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws SPIException

Gets name of this file or directory

Returns:

String representing the file name. The format of the name may be indeterminate. For Netware File system both "/" and "\" are considered valid: "dir3/dir2/dir1/dirname" or "dir3\dir2\dir1\filename"

Throws:

SPIException

getNameBackslashed

java.lang.String getNameBackslashed()
                             throws SPIException

Gets name of this file or directory with backslashes

Returns:

String representing the file name. The name will have "\" as the delimeter between directory and file components.

Throws:

SPIException

getNameForwardslashed

java.lang.String getNameForwardslashed()
                                throws SPIException

Gets name of this file or directory with forwardslashes

Returns:

String representing the file name. The name will have "/" as the delimeter between directory and file components.

Throws:

SPIException

getDirNameBaseNameBackslashed

java.lang.String[] getDirNameBaseNameBackslashed()
                                          throws SPIException

Gets dirname and basename of this file or directory with backslashes

Returns:

A String array where [0] is the dirName portion of this NSFileObject and [1] is the baseName portion of this NSFileObject The dir name will have "\" as the delimeter between directory components. Example "dir3/dir2/dir1/dirname" returns [0]="dir3\dir2\dir1" [1]="dirname" "dir3\dir2\dir1\filename" returns [0]="dir3\dir2\dir1" [1]="filename"

Throws:

SPIException

getDirNameBaseNameForwardslashed

java.lang.String[] getDirNameBaseNameForwardslashed()
                                             throws SPIException

Gets dirname and basename of this file or directory with forwardslashes

Returns:

A String array where [0] is the dirName portion of this NSFileObject and [1] is the baseName portion of this NSFileObject The dir name will have "/" as the delimeter between directory components. Example "dir3/dir2/dir1/dirname" returns [0]="dir3\dir2\dir1" [1]="dirname" "dir3\dir2\dir1\filename" returns [0]="dir3\dir2\dir1" [1]="filename"

Throws:

SPIException

getType

int getType()
     throws SPIException

Get the type of this file object

Returns:

NSFileObject.TYPE_FILE, TYPE_DIRECTORY, TYPE_UNSPECIFIED, or TYPE_NOTEXIST

Throws:

SPIException

getTrustees

NSFileTrustee[] getTrustees()
                     throws SPIException

Get the NSFileTrustee(s) associated with this file object.

Returns:

a NSFileTrustee array. If no trustees have been associated with this file object, this will be a 0 length array - it will not be "null".

Throws:

SPIException

isJunctionFile

boolean isJunctionFile()

Get a boolean indicating if this object is a Junction file

Returns:

true if this object is a Junction file