co.blustor.gatekeepersdk.data

Class GKFile

java.lang.Object

co.blustor.gatekeepersdk.data.GKFile

public class GKFile
extends java.lang.Object

A GKFile represents a file or path on a GateKeeper Card.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GKFile.Type The type of the entry on the GateKeeper Card.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mCardPath The absolute path to the entry on the GateKeeper Card.
protected java.lang.String	mName The name of the file.
protected GKFile.Type	mType The Type of the file.
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
GKFile(java.lang.String name, GKFile.Type type) Create a GKFile with the given name and type.
GKFile(java.lang.String name, GKFile.Type type, int fileSize) Create a GKFile with the given name and type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCardPath() Retrieve the absolute path to the file on the GateKeeper Card.
java.lang.String	getExtension() Retrieve the file system extension (when present) of the file.
java.lang.String	getFilenameBase() Retrieve the filename without the extension (when present) of the file.
int	getFileSize() Retrieve the size of the file as returned from the card.
java.lang.String	getName() Retrieve the name of the file.
java.lang.String	getParentCardPath() Retrieve the parent directory
GKFile.Type	getType() Retrieve the type of the file.
boolean	isDirectory() Retrieve whether the file refers to a directory or a file entry on the GateKeeper Card.
void	setCardPath(java.lang.String fullPath) Assign the absolute path to the file on the GateKeeper Card.
void	setCardPath(java.lang.String parentPath, java.lang.String fileName) Assign the absolute path to the file on the GateKeeper Card.
void	setName(java.lang.String name) Assign the name of the file.
void	setType(GKFile.Type type) Assign the type of the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

mCardPath

protected java.lang.String mCardPath

The absolute path to the entry on the GateKeeper Card.

mName

protected java.lang.String mName

The name of the file.

mType

protected GKFile.Type mType

The Type of the file.

Constructor Detail

GKFile

public GKFile(java.lang.String name,
              GKFile.Type type)

Create a GKFile with the given name and type.

Parameters:

name - the String name of the file

type - the Type of the file

Since:

0.5.0

GKFile

public GKFile(java.lang.String name,
              GKFile.Type type,
              int fileSize)

Create a GKFile with the given name and type.

Parameters:

name - the String name of the file

type - the Type of the file

fileSize - the int size of the file in bytes

Since:

0.15.0

Method Detail

getName

public java.lang.String getName()

Retrieve the name of the file.

Returns:

the name of the file

Since:

0.5.0

setName

public void setName(java.lang.String name)

Assign the name of the file.

Parameters:

name - the String name of the file

Since:

0.5.0

getType

public GKFile.Type getType()

Retrieve the type of the file.

Returns:

the type of the file

Since:

0.5.0

setType

public void setType(GKFile.Type type)

Assign the type of the file.

Parameters:

type - the Type of the file

Since:

0.5.0

isDirectory

public boolean isDirectory()

Retrieve whether the file refers to a directory or a file entry on the GateKeeper Card.

Returns:

true if the file refers to a directory on the GateKeeper Card or false if the file refers to a file entry.

Since:

0.5.0

getExtension

public java.lang.String getExtension()

Retrieve the file system extension (when present) of the file.

Returns:

the String extension of the file. NULL if the file is a directory or does not have an extension.

Since:

0.5.0

getFilenameBase

public java.lang.String getFilenameBase()

Retrieve the filename without the extension (when present) of the file.

Returns:

the String name of the file without extension. NULL if the file is a directory or does not have an extension.

Since:

0.11.0

getCardPath

public java.lang.String getCardPath()

Retrieve the absolute path to the file on the GateKeeper Card.

Returns:

the absolute String path to the file

Since:

0.5.0

setCardPath

public void setCardPath(java.lang.String fullPath)

Assign the absolute path to the file on the GateKeeper Card.

Parameters:

fullPath - the absolute String path to the file

Since:

0.5.0

setCardPath

public void setCardPath(java.lang.String parentPath,
                        java.lang.String fileName)

Assign the absolute path to the file on the GateKeeper Card.

Parameters:

parentPath - the absolute String path to the parent of the file

fileName - the String name of the file

Since:

0.5.0

getParentCardPath

public java.lang.String getParentCardPath()

Retrieve the parent directory

Returns:

the parent directory if present, null otherwise

Since:

0.19.0

getFileSize

public int getFileSize()

Retrieve the size of the file as returned from the card.

Returns:

the int value of the file size

Since:

0.15.0