com.gentics.api.lib.i18n
Class I18nString

java.lang.Object
  extended by com.gentics.api.lib.i18n.I18nString
All Implemented Interfaces:
java.io.Serializable

public abstract class I18nString
extends java.lang.Object
implements java.io.Serializable

Localized string. Is localized automaticaly into a string during rendering by .toString(), usually in template engine.

See Also:
Serialized Form

Nested Class Summary
 class I18nString.I18nStringParameters
          Internal map implementation that transforms keys to the regexes.
 
Field Summary
protected  java.lang.String _key
          key of the i18String
protected  com.gentics.lib.i18n.LanguageProvider languageProvider
          language provider (for translating the key depending on the currently selected language)
 
Constructor Summary
protected I18nString(java.lang.String key, com.gentics.lib.i18n.LanguageProvider languageProvider)
          Create an instance of the I18nString.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
protected  com.gentics.lib.i18n.LanguageProvider getLanguageProvider()
          Method to get the current language provider
 java.util.Map getParameters()
          Get the parameters map
 int hashCode()
           
 int length()
          Get the length of the I18nString
 void setParameter(java.lang.String name, java.lang.Object value)
          sets a variable parameter in the string.
 void setParameters(java.util.Map parameters)
          Set all parameters from the map to the string
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

_key

protected java.lang.String _key
key of the i18String


languageProvider

protected transient com.gentics.lib.i18n.LanguageProvider languageProvider
language provider (for translating the key depending on the currently selected language)

Constructor Detail

I18nString

protected I18nString(java.lang.String key,
                     com.gentics.lib.i18n.LanguageProvider languageProvider)
Create an instance of the I18nString. Instances are always created inside the portal, so this constructor is protected.

Parameters:
key - the key of the i18n item.
languageProvider - the languageprovider to use, for fetching the language during toString.
Method Detail

getLanguageProvider

protected com.gentics.lib.i18n.LanguageProvider getLanguageProvider()
Method to get the current language provider

Returns:
languageprovider

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setParameters

public void setParameters(java.util.Map parameters)
Set all parameters from the map to the string

Parameters:
parameters - parameters as map

setParameter

public void setParameter(java.lang.String name,
                         java.lang.Object value)
sets a variable parameter in the string.

Parameters:
name - name to replace in template, e.g. "name" for replacing $name
value - new value for variable. may also be an object with a toString implementation.

length

public int length()
Get the length of the I18nString

Returns:
length

getParameters

public java.util.Map getParameters()
Get the parameters map

Returns:
parameters map

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.