de.tuberlin.onedrivesdk.common

Class OneItem

java.lang.Object

de.tuberlin.onedrivesdk.common.OneItem

public abstract class OneItem
extends java.lang.Object

The root class of all files and folder types that can be accessed through this sdk.

Field Summary

Fields

Modifier and Type	Field and Description
protected de.tuberlin.onedrivesdk.common.ConcreteOneDriveSDK	api The SDK object.
protected java.util.HashMap<java.lang.String,DriveUser>	createdBy The created by reference.
protected java.lang.String	createdDateTime The creation timestamp of this item.
protected java.lang.String	cTag The cTag.
protected java.lang.String	downloadUrl A Url that can be used to download this file's content.
protected java.lang.String	eTag The eTag.
protected java.lang.String	id The OneDrive id of the resource.
protected java.util.HashMap<java.lang.String,DriveUser>	lastModifiedBy The modified by reference.
protected java.lang.String	lastModifiedDateTime The last modified timestamp of this item.
protected java.lang.String	name The Name.
protected ParentReference	parentReference The parent folder reference.
protected java.lang.String	rawJson The raw JSON which is received from the OneDrive API.
protected long	size The size of an item in bytes.
protected java.lang.String	webUrl URL that displays the resource in the browser.

Constructor Summary

Constructors

Constructor and Description
OneItem()

Method Summary

Modifier and Type	Method and Description
boolean	delete() Delete the item.
static OneItem	fromJSON(java.lang.String json) Parse a OneItem object from JSON.
java.util.HashMap<java.lang.String,DriveUser>	getCreatedBy() The created by reference.
long	getCreatedDateTime() The creation timestamp of this item.
java.lang.String	getCTag() Gets the cTag.
java.lang.String	getETag() Gets the eTag.
java.lang.String	getId() Gets the id of the item.
java.util.HashMap<java.lang.String,DriveUser>	getLastModifiedBy() The modified by reference.
long	getLastModifiedDateTime() The last modified timestamp of this item.
long	getLastRefresh() Gets the timestamp of the last refresh.
java.lang.String	getName() Gets the name of the item.
OneFolder	getParentFolder() Gets the parent folder.
java.lang.String	getRawJson() Gets the raw JSON which is received from the OneDrive API.
long	getSize() Gets the size of this item in bytes.
java.lang.String	getWebUrl() Gets the URL that displays the resource in the browser.
abstract boolean	isFile() Is file.
abstract boolean	isFolder() Is folder.
static java.util.List<OneItem>	parseItemsFromJson(java.lang.String json) Parse a List of OneItems from JSON.
static java.util.List<OneItem>	parseItemsFromJson(java.lang.String json, OneItemType type) Parse a List of OneItems from JSON.
OneItem	refreshItem() Refresh the item state.
OneItem	setApi(de.tuberlin.onedrivesdk.common.ConcreteOneDriveSDK api) Sets the api object.
OneItem	setLastRefresh(long lastRefresh) Sets the timestamp of the last refresh.
OneItem	setRawJson(java.lang.String rawJson) Sets the raw json.

Methods inherited from class java.lang.Object

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

Field Detail

api

protected de.tuberlin.onedrivesdk.common.ConcreteOneDriveSDK api

The SDK object.

id

protected java.lang.String id

The OneDrive id of the resource.

name

protected java.lang.String name

The Name.

createdBy

protected java.util.HashMap<java.lang.String,DriveUser> createdBy

The created by reference. Possible keys are 'user', 'application' and 'device'.

createdDateTime

protected java.lang.String createdDateTime

The creation timestamp of this item.

lastModifiedBy

protected java.util.HashMap<java.lang.String,DriveUser> lastModifiedBy

The modified by reference. Possible keys are 'user', 'application' and 'device'.

lastModifiedDateTime

protected java.lang.String lastModifiedDateTime

The last modified timestamp of this item.

cTag

protected java.lang.String cTag

The cTag.

eTag

protected java.lang.String eTag

The eTag.

size

protected long size

The size of an item in bytes.

webUrl

protected java.lang.String webUrl

URL that displays the resource in the browser.

parentReference

protected ParentReference parentReference

The parent folder reference.

rawJson

protected java.lang.String rawJson

The raw JSON which is received from the OneDrive API.

downloadUrl

protected java.lang.String downloadUrl

A Url that can be used to download this file's content.

Constructor Detail

OneItem

public OneItem()

Method Detail

fromJSON

public static OneItem fromJSON(java.lang.String json)
                        throws org.json.simple.parser.ParseException,
                               OneDriveException

Parse a OneItem object from JSON.

Parameters:

json - JSON from the OneDrive API

Returns:

OneItem

Throws:

org.json.simple.parser.ParseException - if the JSON can not be parsed

OneDriveException - if the JSON contains an OneDrive Error object from the API

parseItemsFromJson

public static java.util.List<OneItem> parseItemsFromJson(java.lang.String json)
                                                  throws org.json.simple.parser.ParseException,
                                                         OneDriveException

Parse a List of OneItems from JSON.

Parameters:

json - JSON from the OneDrive API

Returns:

a List of OneItems

Throws:

org.json.simple.parser.ParseException - if the JSON can not be parsed

OneDriveException - if the JSON contains an OneDrive Error object from the API

parseItemsFromJson

public static java.util.List<OneItem> parseItemsFromJson(java.lang.String json,
                                                         OneItemType type)
                                                  throws org.json.simple.parser.ParseException,
                                                         OneDriveException

Parse a List of OneItems from JSON.

Parameters:

json - JSON from the OneDrive API

type - OneItemType, can be used to define which type of items should be parsed

Returns:

items from json

Throws:

org.json.simple.parser.ParseException - if the JSON can not be parsed

OneDriveException - if the json dose not contain a 'value' attribute

getName

public java.lang.String getName()

Gets the name of the item.

Returns:

name

setApi

public OneItem setApi(de.tuberlin.onedrivesdk.common.ConcreteOneDriveSDK api)
               throws OneDriveException

Sets the api object.

Parameters:

api - the api object

Returns:

the identity

Throws:

OneDriveException - if the api is null

getId

public java.lang.String getId()

Gets the id of the item.

Returns:

id

delete

public boolean delete()
               throws java.io.IOException,
                      OneDriveException

Delete the item.

Returns:

true if the item was deleted from OneDrive.

Throws:

java.io.IOException

OneDriveException

getCTag

public java.lang.String getCTag()

Gets the cTag.

Returns:

cTag

getETag

public java.lang.String getETag()

Gets the eTag.

Returns:

eTag

getCreatedBy

public java.util.HashMap<java.lang.String,DriveUser> getCreatedBy()

The created by reference. Possible keys are 'user', 'application' and 'device'.

Returns:

created by

getCreatedDateTime

public long getCreatedDateTime()

The creation timestamp of this item.

Returns:

unix formatted timestamp

getLastModifiedBy

public java.util.HashMap<java.lang.String,DriveUser> getLastModifiedBy()

The modified by reference. Possible keys are 'user', 'application' and 'device'.

Returns:

last modified by

getLastModifiedDateTime

public long getLastModifiedDateTime()

The last modified timestamp of this item.

Returns:

unix formatted timestamp

getSize

public long getSize()

Gets the size of this item in bytes.

Returns:

size

getWebUrl

public java.lang.String getWebUrl()

Gets the URL that displays the resource in the browser.

Returns:

web url

getParentFolder

public OneFolder getParentFolder()
                          throws java.io.IOException,
                                 OneDriveException

Gets the parent folder.

Returns:

parent folder

Throws:

java.io.IOException

OneDriveException

getRawJson

public java.lang.String getRawJson()

Gets the raw JSON which is received from the OneDrive API.

Returns:

raw json

setRawJson

public OneItem setRawJson(java.lang.String rawJson)

Sets the raw json.

Parameters:

rawJson - json

Returns:

raw json

getLastRefresh

public long getLastRefresh()

Gets the timestamp of the last refresh.

Returns:

timestamp in milliseconds

setLastRefresh

public OneItem setLastRefresh(long lastRefresh)

Sets the timestamp of the last refresh.

Parameters:

lastRefresh - timestamp in milliseconds

Returns:

last refresh

refreshItem

public OneItem refreshItem()
                    throws java.io.IOException,
                           OneDriveException

Refresh the item state.

Returns:

item the reference of this item will be another one.

Throws:

java.io.IOException

OneDriveException

isFile

public abstract boolean isFile()

Is file.

Returns:

boolean

isFolder

public abstract boolean isFolder()

Is folder.

Returns:

boolean