com.sapportals.wcm.util.resource

Class Descriptions

java.lang.Object
  com.sapportals.wcm.util.resource.Descriptions

public class Descriptions
extends Object

Store several description strings in one object.

Copyright (c) SAP AG 2001-2002

Field Summary

static String	DEFAULT The key for the default description.
static Locale	DEFAULT_LOCALE The default locale in the system.

Constructor Summary

Descriptions()
Create an empty description set.

Descriptions(Properties descriptions)
Create a description set with the locale-id's (as from Locale.toString() ) as keys.

Method Summary

String	getDescription(Locale locale)
static String	getDescription(Locale locale, Properties descriptions)
static Locale	getLocale(String localeID)
Locale[]	getLocales()
static Locale[]	getLocales(Properties descriptions)
static String[]	getRequiredLocaleKeys()
void	setDescription(Locale locale, String description)
Properties	toProperties()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static String DEFAULT

The key for the default description.

DEFAULT_LOCALE

public static Locale DEFAULT_LOCALE

The default locale in the system.

Constructor Detail

Descriptions

public Descriptions()

Create an empty description set.

Descriptions

public Descriptions(Properties descriptions)

Create a description set with the locale-id's (as from Locale.toString() ) as keys.

Parameters:

descriptions - a bag of Properties with the locale id's as keys (e.g. de for german, en_us for us english).

Method Detail

getDescription

public static String getDescription(Locale locale,
                                    Properties descriptions)

getLocale

public static Locale getLocale(String localeID)

getLocales

public static Locale[] getLocales(Properties descriptions)

getRequiredLocaleKeys

public static String[] getRequiredLocaleKeys()

getDescription

public String getDescription(Locale locale)

getLocales

public Locale[] getLocales()

setDescription

public void setDescription(Locale locale,
                           String description)

toProperties

public Properties toProperties()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM