Interface File
- 
- All Superinterfaces:
- BaseAsset,- FolderContainedAsset,- MetadataAwareAsset,- NamedAsset,- PermissionsCapableAsset,- PublishableAsset
 
 public interface File extends PublishableAsset Represents a file asset.- Since:
- 4.7
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description byte[]getData()Get the file's data as a byte array.ImageDimensionsgetDimensions()java.lang.LonggetFileSize()Similar to calling {@link #getData().length} but will execute much faster and take much less memory.java.lang.StringgetText()Returns the file's data in form of a String.voidsetData(byte[] data)Set the file's data as a byte array.- 
Methods inherited from interface com.hannonhill.cascade.api.asset.common.BaseAssetgetAssetId, getAssetType, getIdentifer
 - 
Methods inherited from interface com.hannonhill.cascade.api.asset.home.FolderContainedAssetgetCreatedBy, getCreatedOn, getFolderOrder, getIdentifier, getLastModified, getLastModifiedBy, getParentFolder, getParentFolderIdentifier, getPath, getSite, getSiteId, getSiteName, getTags, isHideSystemName, setHideSystemName, setParentFolder, setParentFolderIdentifier
 - 
Methods inherited from interface com.hannonhill.cascade.api.asset.home.MetadataAwareAssetgetLabel, getLinkingAssets, getMetadata, getMetadataSet, getMetadataSetId
 - 
Methods inherited from interface com.hannonhill.cascade.api.asset.common.NamedAssetgetName, setName
 - 
Methods inherited from interface com.hannonhill.cascade.api.asset.common.PermissionsCapableAssetisCurrentUserCanRead, isCurrentUserCanWrite, isUserCanRead, isUserCanWrite
 - 
Methods inherited from interface com.hannonhill.cascade.api.asset.home.PublishableAssetgetLastPublishedBy, getLastPublishedOn, getLink, getShouldBeIndexed, getShouldBePublished, setIncludeWhenIndexing, setIncludeWhenPublishing
 
- 
 
- 
- 
- 
Method Detail- 
getDatabyte[] getData() Get the file's data as a byte array.- Returns:
- the byte data of the file
 
 - 
setDatavoid setData(byte[] data) Set the file's data as a byte array.- Parameters:
- data- the byte data for the file
 
 - 
getTextjava.lang.String getText() Returns the file's data in form of a String.- Returns:
 
 - 
getFileSizejava.lang.Long getFileSize() Similar to calling {@link #getData().length} but will execute much faster and take much less memory.- Returns:
 
 - 
getDimensionsImageDimensions getDimensions() - Returns:
- returns an ImageDimensionsrepresenting the height and width of an image file. This method can return null if image dimensions are not applicable for the file or if the image file does not have any dimensions populated.
 
 
- 
 
-