Package org.hippoecm.hst.content.beans.standard

Interface HippoResourceBean

All Superinterfaces:

Comparable<HippoBean>, ContentBean, HippoBean, IdentifiableContentBean, NodeAware, ObjectConverterAware

All Known Subinterfaces:

HippoGalleryImageBean

public interface HippoResourceBean
extends HippoBean

This is a base interface for all beans that represent a hippo resource should implement.

Field Summary

Fields inherited from interface org.hippoecm.hst.content.beans.standard.HippoBean

log

Method Summary

Modifier and Type	Method	Description
String	getFilename()	Get the file name of this resource or null if unavailable.
Calendar	getLastModified()
long	getLength()
BigDecimal	getLengthKB()	Return size in kilobytes
BigDecimal	getLengthMB()	Return size in kilobytes
String	getMimeType()	Get the mime type of this resource.
default String	getRepresentationId()	in the Page Model API we do not want to show uuid for nodes below a document (compound)
boolean	isBlank()	Return true if this resource contains blank data and should not be used by the frontend.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.hippoecm.hst.content.beans.standard.HippoBean

equalCompare, getAvailableTranslations, getBean, getBean, getBeanByUUID, getCanonicalBean, getCanonicalPath, getCanonicalUUID, getChildBeans, getChildBeans, getChildBeansByName, getChildBeansByName, getComparePath, getContentType, getDisplayName, getEqualComparator, getLinkedBean, getLinkedBeans, getMultipleProperty, getMultipleProperty, getName, getNode, getParentBean, getPath, getProperties, getProperty, getSingleProperty, getSingleProperty, getValueProvider, isAncestor, isDescendant, isHippoDocumentBean, isHippoFolderBean, isLeaf, isSelf, isVersionedNode

Methods inherited from interface org.hippoecm.hst.content.beans.standard.IdentifiableContentBean

getIdentifier, setIdentifier

Methods inherited from interface org.hippoecm.hst.content.beans.NodeAware

setNode

Methods inherited from interface org.hippoecm.hst.content.beans.manager.ObjectConverterAware

getObjectConverter, setObjectConverter

Method Details

getRepresentationId

default String getRepresentationId()

in the Page Model API we do not want to show uuid for nodes below a document (compound)

Specified by:

getRepresentationId in interface IdentifiableContentBean

Returns:

the representational id for this IdentifiableContentBean

getMimeType

String getMimeType()

Get the mime type of this resource.

Returns:

the mime type of this resource

getFilename

String getFilename()

Get the file name of this resource or null if unavailable.

Returns:

the file name of this resource or null if unavailable

getLength

long getLength()

Returns:

the number of bytes of binary stored in this resource

getLengthKB

BigDecimal getLengthKB()

Return size in kilobytes

Returns:

kilobytes

getLengthMB

BigDecimal getLengthMB()

Return size in kilobytes

Returns:

megabytes

getLastModified

Calendar getLastModified()

Returns:

the last modified date of this resource and null if there is no last modified (should never happen though)

isBlank

boolean isBlank()

Return true if this resource contains blank data and should not be used by the frontend. This differs from getLength() == 0 which may represent an empty file.

Returns:

true if this resource contains blank data