org.hippoecm.hst.content.beans.standard

Class AvailableTranslations<K extends HippoBean>

java.lang.Object

org.hippoecm.hst.content.beans.standard.AvailableTranslations<K>

All Implemented Interfaces:

HippoAvailableTranslationsBean<K>

public class AvailableTranslations<K extends HippoBean>
extends Object
implements HippoAvailableTranslationsBean<K>

This is a useful POJO/BEAN (non jcr node backed bean, not extending HippoItem or implementing HippoBean) for finding available translations of one and the same bean (folder or document).

Nested Class Summary

Nested classes/interfaces inherited from interface org.hippoecm.hst.content.beans.standard.HippoAvailableTranslationsBean

HippoAvailableTranslationsBean.NoopTranslationsBean<K extends HippoBean>

Constructor Summary

Constructors

Constructor and Description
AvailableTranslations(javax.jcr.Node node)
AvailableTranslations(javax.jcr.Node node, ObjectConverter objectConverter) Deprecated. Deprecated since CMS 11.0.0 (HST 4.0.0). Use AvailableTranslations(Node) instead.

Method Summary

Modifier and Type	Method and Description
List<String>	getAvailableLocales() Returns the available translations.
K	getTranslation(String locale)
List<K>	getTranslations()
boolean	hasTranslation(String locale)
void	setBeanMappingClass(Class<K> beanMappingClass) Sets the beanMappingClass for this HippoAvailableTranslationsBean.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailableTranslations

public AvailableTranslations(javax.jcr.Node node)

AvailableTranslations

@Deprecated
public AvailableTranslations(javax.jcr.Node node,
                                         ObjectConverter objectConverter)

Deprecated. Deprecated since CMS 11.0.0 (HST 4.0.0). Use AvailableTranslations(Node) instead.

Parameters:

node - the node to get the translations for

Method Detail

getAvailableLocales

public List<String> getAvailableLocales()

Description copied from interface: HippoAvailableTranslationsBean

Returns the available translations.

Specified by:

getAvailableLocales in interface HippoAvailableTranslationsBean<K extends HippoBean>

Returns:

the List of available locales and an empty List is no locales are present

getTranslation

public K getTranslation(String locale)

Specified by:

getTranslation in interface HippoAvailableTranslationsBean<K extends HippoBean>

Parameters:

locale - the locale for the translation

Returns:

returns translation for locale and null if not present

getTranslations

public List<K> getTranslations()

Specified by:

getTranslations in interface HippoAvailableTranslationsBean<K extends HippoBean>

Returns:

the List of all translations or an empty List if no translations found

hasTranslation

public boolean hasTranslation(String locale)

Specified by:

hasTranslation in interface HippoAvailableTranslationsBean<K extends HippoBean>

Returns:

true when the translation for locale is present

setBeanMappingClass

public void setBeanMappingClass(Class<K> beanMappingClass)

Sets the beanMappingClass for this HippoAvailableTranslationsBean. Only translations of type beanMappingClass will be returned

Parameters:

beanMappingClass - the type of class the available translations should be off