com.box.boxjavalibv2.dao

Class BoxPreview

java.lang.Object

com.box.boxjavalibv2.dao.BoxBase

com.box.boxjavalibv2.jsonentities.DefaultJSONStringEntity

com.box.boxjavalibv2.dao.BoxObject

com.box.boxjavalibv2.dao.BoxPreview

All Implemented Interfaces:

IBoxJSONStringEntity, IBoxParcelable

public class BoxPreview
extends BoxObject

Preview of a file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_HEIGHT
static String	MAX_WIDTH
static String	MIN_HEIGHT
static String	MIN_WIDTH
static String	PAGE

Constructor Summary

Constructors

Constructor and Description
BoxPreview()

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getContent() Get content of the preview.
Integer	getFirstPage() Get the first page number.
Integer	getLastPage() Get the last page number.
Integer	getNumPages() Get number of pages.
void	setContent(InputStream content) Set content.
void	setFirstPage(Integer firstPage)
void	setLastPage(int lastPage) Set the last page number.
void	writeToParcel(IBoxParcelWrapper parcelWrapper, int flags)

Methods inherited from class com.box.boxjavalibv2.dao.BoxObject

contains, equals, extraProperties, getExtraData, getValue, handleUnknown, hashCode, put

Methods inherited from class com.box.boxjavalibv2.jsonentities.DefaultJSONStringEntity

toJSONString

Methods inherited from class java.lang.Object

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

Field Detail

MIN_WIDTH

public static final String MIN_WIDTH

See Also:

Constant Field Values

MIN_HEIGHT

public static final String MIN_HEIGHT

See Also:

Constant Field Values

MAX_WIDTH

public static final String MAX_WIDTH

See Also:

Constant Field Values

MAX_HEIGHT

public static final String MAX_HEIGHT

See Also:

Constant Field Values

PAGE

public static final String PAGE

See Also:

Constant Field Values

Constructor Detail

BoxPreview

public BoxPreview()

Method Detail

setFirstPage

public void setFirstPage(Integer firstPage)

Parameters:

firstPage - first page number

getFirstPage

public Integer getFirstPage()

Get the first page number.

Returns:

the first page number.

setLastPage

public void setLastPage(int lastPage)

Set the last page number.

Parameters:

lastPage - last page number

getLastPage

public Integer getLastPage()

Get the last page number.

Returns:

the last page number

getContent

public InputStream getContent()
                       throws BoxRestException

Get content of the preview. Caller is responsible for closing the InputStream.

Returns:

preview input stream.

Throws:

BoxException

BoxRestException

getNumPages

public Integer getNumPages()

Get number of pages.

Returns:

number of pages

setContent

public void setContent(InputStream content)

Set content.

Parameters:

content - content

writeToParcel

public void writeToParcel(IBoxParcelWrapper parcelWrapper,
                 int flags)

Specified by:

writeToParcel in interface IBoxParcelable

Overrides:

writeToParcel in class BoxObject