|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.felix.metatype.internal.LocalizedObjectClassDefinition
public class LocalizedObjectClassDefinition
The LocalizedObjectClassDefinition
class is the implementation
of the ObjectClassDefinition
interface. This class delegates
calls to the underlying OCD
localizing the results of the following
methods: getName()
, getDescription()
, and
getIcon(int)
.
Field Summary |
---|
Fields inherited from interface org.osgi.service.metatype.ObjectClassDefinition |
---|
ALL, OPTIONAL, REQUIRED |
Constructor Summary | |
---|---|
LocalizedObjectClassDefinition(Bundle bundle,
OCD ocd,
Resources resources)
Creates and instance of this localizing facade. |
Method Summary | |
---|---|
AttributeDefinition[] |
getAttributeDefinitions(int filter)
Return the attribute definitions for this object class. |
String |
getDescription()
Return a description of this object class. |
InputStream |
getIcon(int size)
Return an InputStream object that can be used to create an
icon from. |
String |
getID()
Return the id of this object class. |
String |
getName()
Return the name of this object class. |
protected Resources |
getResources()
Returns the Resources assigned to this instance. |
protected String |
localize(String string)
Localizes the string using the ResourceBundle set on this instance if
string starts with the percent character (% ). |
protected String[] |
localize(String[] strings)
Calls localize(String) for each string in the array and returns
an array of the resulting localized strings. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocalizedObjectClassDefinition(Bundle bundle, OCD ocd, Resources resources)
bundle
- The Bundle
providing this object class
definition.ocd
- The OCD
to which calls are delegated.resources
- The Resources
used to localize return values of
localizable methods.Method Detail |
---|
public AttributeDefinition[] getAttributeDefinitions(int filter)
ObjectClassDefinition
Return a set of attributes. The filter parameter can distinguish between
ALL
,REQUIRED
or the OPTIONAL
attributes.
getAttributeDefinitions
in interface ObjectClassDefinition
filter
-
null
if no
attributes are selectedObjectClassDefinition.getAttributeDefinitions(int)
public String getDescription()
ObjectClassDefinition
getDescription
in interface ObjectClassDefinition
ObjectClassDefinition.getDescription()
public InputStream getIcon(int size) throws IOException
ObjectClassDefinition
InputStream
object that can be used to create an
icon from.
Indicate the size and return an InputStream
object containing
an icon. The returned icon maybe larger or smaller than the indicated
size.
The icon may depend on the localization.
getIcon
in interface ObjectClassDefinition
size
-
null
IOException
ObjectClassDefinition.getIcon(int)
public String getID()
ObjectClassDefinition
ObjectDefintion
objects share a global namespace in the
registry. They share this aspect with LDAP/X.500 attributes. In these
standards the OSI Object Identifier (OID) is used to uniquely identify
object classes. If such an OID exists, (which can be requested at several
standard organisations and many companies already have a node in the
tree) it can be returned here. Otherwise, a unique id should be returned
which can be a java class name (reverse domain name) or generated with a
GUID algorithm. Note that all LDAP defined object classes already have an
OID associated. It is strongly advised to define the object classes from
existing LDAP schemes which will give the OID for free. Many such schemes
exist ranging from postal addresses to DHCP parameters.
getID
in interface ObjectClassDefinition
ObjectClassDefinition.getID()
public String getName()
ObjectClassDefinition
getName
in interface ObjectClassDefinition
ObjectClassDefinition.getName()
protected Resources getResources()
Resources
assigned to this instance.
protected String[] localize(String[] strings)
localize(String)
for each string in the array and returns
an array of the resulting localized strings. If strings
is
null
null
is returned.
strings
- An array of non-null
strings to localize.
null
if strings
is null
or
an array of the same size as the strings
array
containing localized strings.protected String localize(String string)
ResourceBundle
set on this instance if
string starts with the percent character (%
). If the
string is null
, does not start with a percent character
or the resource whose key is the string without the leading the percent
character is not found the string is returned without the leading percent
character.
Examples of different localizations:
string |
Key | Resource | Result |
---|---|---|---|
null |
- | - | null |
sample | - | - | sample |
%sample | sample | - | sample |
%sample | sample | resource | resource |
string
- The string to localize
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |