com.google.cloud.hadoop.gcsio

Class FileInfo

java.lang.Object

com.google.cloud.hadoop.gcsio.FileInfo

public class FileInfo
extends Object

Contains information about a file or a directory. Note: This class wraps GoogleCloudStorageItemInfo, adds file system specific information and hides bucket/object specific information. The wrapped type should not be visible to callers of GoogleCloudStorageFileSystem because it exposes non-file system information (eg, buckets).

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_MODIFICATION_TIMESTAMP_KEY
static LogUtil	log
static FileInfo	ROOT_INFO

Method Summary

Methods

Modifier and Type	Method and Description
static void	addModificationTimeToAttributes(Map<String,byte[]> attributes, com.google.api.client.util.Clock clock) Add a key and value representing the current time, as determined by the passed clock, to the passed attributes dictionary.
static StorageResourceId	convertToDirectoryPath(StorageResourceId resourceId) Converts the given resourceId to look like a directory path.
static URI	convertToDirectoryPath(URI path) Converts the given path to look like a directory path.
static String	convertToFilePath(String objectName) Converts the given object name to look like a file path.
boolean	exists() Indicates whether this file or directory exists.
static FileInfo	fromItemInfo(GoogleCloudStorageItemInfo itemInfo) Handy factory method for constructing a FileInfo from a GoogleCloudStorageItemInfo while potentially returning a singleton instead of really constructing an object for cases like ROOT.
static List<FileInfo>	fromItemInfos(List<GoogleCloudStorageItemInfo> itemInfos) Handy factory method for constructing a list of FileInfo from a list of GoogleCloudStorageItemInfo.
Map<String,byte[]>	getAttributes() Retrieve file attributes for this file.
long	getCreationTime() Gets creation time of this item.
GoogleCloudStorageItemInfo	getItemInfo() Gets information about the underlying item.
long	getModificationTime() Gets the modification time of this file if one is set, otherwise the value of getCreationTime() is returned.
URI	getPath() Gets the path of this file or directory.
long	getSize() Gets the size of this file or directory.
boolean	isDirectory() Indicates whether this item is a directory.
static boolean	isDirectoryPath(URI path) Indicates whether the given path looks like a directory path.
boolean	isGlobalRoot() Indicates whether this instance has information about the unique, shared root of the underlying storage system.
String	toString() Gets string representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static LogUtil log

ROOT_INFO

public static final FileInfo ROOT_INFO

FILE_MODIFICATION_TIMESTAMP_KEY

public static final String FILE_MODIFICATION_TIMESTAMP_KEY

See Also:

Constant Field Values

Method Detail

getPath

public URI getPath()

Gets the path of this file or directory.

isDirectory

public boolean isDirectory()

Indicates whether this item is a directory.

isGlobalRoot

public boolean isGlobalRoot()

Indicates whether this instance has information about the unique, shared root of the underlying storage system.

getCreationTime

public long getCreationTime()

Gets creation time of this item. Time is expressed as milliseconds since January 1, 1970 UTC.

getSize

public long getSize()

Gets the size of this file or directory. For files, size is in number of bytes. For directories size is 0. For items that do not exist, size is -1.

getModificationTime

public long getModificationTime()

Gets the modification time of this file if one is set, otherwise the value of getCreationTime() is returned. Time is expressed as milliseconds since January 1, 1970 UTC.

getAttributes

public Map<String,byte[]> getAttributes()

Retrieve file attributes for this file.

Returns:

A map of file attributes

exists

public boolean exists()

Indicates whether this file or directory exists.

toString

public String toString()

Gets string representation of this instance.

Overrides:

toString in class Object

getItemInfo

public GoogleCloudStorageItemInfo getItemInfo()

Gets information about the underlying item.

addModificationTimeToAttributes

public static void addModificationTimeToAttributes(Map<String,byte[]> attributes,
                                   com.google.api.client.util.Clock clock)

Add a key and value representing the current time, as determined by the passed clock, to the passed attributes dictionary.

Parameters:

attributes - The file attributes map to update

clock - The clock to retrieve the current time from

convertToFilePath

public static String convertToFilePath(String objectName)

Converts the given object name to look like a file path. If the object name already looks like a file path then this call is a no-op. If the object name is null or empty, it is returned as-is.

Parameters:

objectName - Name of the object to inspect.

Returns:

File path for the given path.

fromItemInfo

public static FileInfo fromItemInfo(GoogleCloudStorageItemInfo itemInfo)

Handy factory method for constructing a FileInfo from a GoogleCloudStorageItemInfo while potentially returning a singleton instead of really constructing an object for cases like ROOT.

fromItemInfos

public static List<FileInfo> fromItemInfos(List<GoogleCloudStorageItemInfo> itemInfos)

Handy factory method for constructing a list of FileInfo from a list of GoogleCloudStorageItemInfo.

isDirectoryPath

public static boolean isDirectoryPath(URI path)

Indicates whether the given path looks like a directory path.

Parameters:

path - Path to inspect.

Returns:

Whether the path looks like a directory path.

convertToDirectoryPath

public static StorageResourceId convertToDirectoryPath(StorageResourceId resourceId)

Converts the given resourceId to look like a directory path. If the path already looks like a directory path then this call is a no-op.

Parameters:

resourceId - StorageResourceId to convert.

Returns:

A resourceId with a directory path corresponding to the given resourceId.

convertToDirectoryPath

public static URI convertToDirectoryPath(URI path)

Converts the given path to look like a directory path. If the path already looks like a directory path then this call is a no-op.

Parameters:

path - Path to convert.

Returns:

Directory path for the given path.