Package org.opencms.jsp.decorator

Class CmsDecorationBundle

java.lang.Object
org.opencms.jsp.decorator.CmsDecorationBundle
public class CmsDecorationBundle extends Object
CmsDecorationBundle, contains a map of merged CmsDEcorationMaps.

The map inside the decoration bundle uses the decoration as keys and CmsDecorationObjects as values.

A decoration bundle contains either all decoarions for one locale (similar to a resource bundle), or is locale independend. If its a locale independend bundle, the included locale is set to null.

Since:
6.1.3

  • Constructor Details

    • CmsDecorationBundle

      public CmsDecorationBundle()
      Constructor, creates a new, empty CmsDecorationBundle.

    • CmsDecorationBundle

      public CmsDecorationBundle(Locale locale)
      Constructor, creates a new CmsDecorationBundle for a given locale.

      Parameters:
      locale - the locale of this bundle or null

  • Method Details

    • get

      public Object get(Object key)
      Gets an object from the decoration bundle.

      Parameters:
      key - the key of the object ot get
      Returns:
      the value matching the key or null.

    • getAll

      public Map<String,CmsDecorationObject> getAll()
      Gets the map of all decoarion bundle entries.

      Returns:
      map of all decoarion bundle entries

    • getLocale

      public Locale getLocale()
      Gets the locale of this decoration bundle.

      Returns:
      locale of the decoration bundle

    • keySet

      public Set<String> keySet()
      Gets the keyset of the decoration bundle map.

      Returns:
      keyset of the decoration bundle map

    • put

      public void put(String key, CmsDecorationObject value)
      Stores an obiect in the decoration bundle.

      Parameters:
      key - the key of the object to store
      value - the value of the object to store

    • putAll

      public void putAll(Map<String,CmsDecorationObject> map)
      Puts a complete map of objects into bundle.

      Parameters:
      map - the map to put into the bundle

    • setLocale

      public void setLocale(Locale locale)
      Sets the locale of the decoration bundle.

      Parameters:
      locale - the locale to set