org.eclipse.equinox.internal.p2.metadata

Class TranslationSupport

java.lang.Object

org.eclipse.equinox.internal.p2.metadata.TranslationSupport

public class TranslationSupport
extends java.lang.Object

TranslationSupport provides string translations for properties of an IInstallableUnit. Clients can specify an IQueryable that should be used to obtain the translation fragment IU's, as well as the locale that should be used for translations.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PI_METADATA

Constructor Summary

Constructors

Constructor and Description
TranslationSupport() Create an instance of TranslationSupport for the current locale.
TranslationSupport(IQueryable<IInstallableUnit> fragmentSource) Create an instance of TranslationSupport for the current locale.

Method Summary

Modifier and Type	Method and Description
ICopyright	getCopyright(IInstallableUnit iu, java.lang.String locale) Return the copyright for the specified IInstallableUnit, localized for the receiver's locale.
static TranslationSupport	getInstance()
java.lang.String	getIUProperty(IInstallableUnit iu, KeyWithLocale propertyKey) Return the localized value for the specified IInstallableUnit property using the locale specified in the propertyKey.
java.lang.String	getIUProperty(IInstallableUnit iu, java.lang.String propertyKey) Return the localized value for the specified IInstallableUnit property using the default locale.
java.lang.String	getIUProperty(IInstallableUnit iu, java.lang.String propertyKey, java.lang.String locale) Return the localized value for the specified IInstallableUnit property.
ILicense[]	getLicenses(IInstallableUnit iu, java.lang.String locale) Return an array of licenses for the specified IInstallableUnit, localized for the receiver's locale.
IUpdateDescriptor	getUpdateDescriptor(IInstallableUnit iu, java.lang.String locale) Return an update descriptor localized for the receiver's locale.
void	setLocaleProvider(LocaleProvider provider) Set the locale that should be used when obtaining translations.
IQueryable<IInstallableUnit>	setTranslationSource(IQueryable<IInstallableUnit> queryable) Set the IQueryable that should be used to obtain translation fragment IUs.

Methods inherited from class java.lang.Object

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

Field Detail

PI_METADATA

public static final java.lang.String PI_METADATA

See Also:

Constant Field Values

Constructor Detail

TranslationSupport

public TranslationSupport()

Create an instance of TranslationSupport for the current locale. Unless otherwise specified, the currently running profile will serve as the source of the translation fragments.

Since:

2.0

TranslationSupport

public TranslationSupport(IQueryable<IInstallableUnit> fragmentSource)

Create an instance of TranslationSupport for the current locale. using the fragmentSource as the source of the translation fragments.

Since:

2.0

Method Detail

getInstance

public static TranslationSupport getInstance()

getCopyright

public ICopyright getCopyright(IInstallableUnit iu,
                               java.lang.String locale)

Return the copyright for the specified IInstallableUnit, localized for the receiver's locale.

Parameters:

iu - the IInstallableUnit in question

Returns:

the localized copyright defined by the IInstallableUnit

getIUProperty

public java.lang.String getIUProperty(IInstallableUnit iu,
                                      java.lang.String propertyKey,
                                      java.lang.String locale)

Return the localized value for the specified IInstallableUnit property.

Parameters:

iu - the IInstallableUnit in question

propertyKey - the name of the property to be retrieved

locale - The locale to return the property for

Returns:

the localized property value, or null if no such property is defined.

getIUProperty

public java.lang.String getIUProperty(IInstallableUnit iu,
                                      KeyWithLocale propertyKey)

Return the localized value for the specified IInstallableUnit property using the locale specified in the propertyKey.

Parameters:

iu - the IInstallableUnit in question

propertyKey - the name and locale of the property to be retrieved

Returns:

the localized property value, or null if no such property is defined.

getIUProperty

public java.lang.String getIUProperty(IInstallableUnit iu,
                                      java.lang.String propertyKey)

Return the localized value for the specified IInstallableUnit property using the default locale.

Parameters:

iu - the IInstallableUnit in question

propertyKey - the name of the property to be retrieved

Returns:

the localized property value, or null if no such property is defined.

getLicenses

public ILicense[] getLicenses(IInstallableUnit iu,
                              java.lang.String locale)

Return an array of licenses for the specified IInstallableUnit, localized for the receiver's locale.

Parameters:

iu - the IInstallableUnit in question

Returns:

the localized licenses defined by the IInstallableUnit

getUpdateDescriptor

public IUpdateDescriptor getUpdateDescriptor(IInstallableUnit iu,
                                             java.lang.String locale)

Return an update descriptor localized for the receiver's locale.

Parameters:

iu - the IInstallableUnit in question

Returns:

the localized update descriptor defined by the IInstallableUnit

setLocaleProvider

public void setLocaleProvider(LocaleProvider provider)

Set the locale that should be used when obtaining translations.

Parameters:

provider - the locale for which translations should be retrieved.

setTranslationSource

public IQueryable<IInstallableUnit> setTranslationSource(IQueryable<IInstallableUnit> queryable)

Set the IQueryable that should be used to obtain translation fragment IUs. Returns the previous translation source.

Parameters:

queryable - an IQueryable that can supply the appropriate NLS translation fragments