Package org.eigenbase.resgen
Interface Resource
public interface Resource
A
Resource
is a collection of messages for a particular
software component and locale. It is loaded from an XML file whose root
element is <BaflResourceList>
.
Given such an XML file, ResourceGen
can generate Java a wrapper
class which implements this interface, and also has a method to create an
error for each message.
- Since:
- 3 December, 2001
- Version:
- $Id: //open/util/resgen/src/org/eigenbase/resgen/Resource.java#4 $
- Author:
- jhyde
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionformatError
(int code, Object[] args) Formats the message corresponding tocode
with the given arguments.Returns the locale of the messages.int
getSeverity
(int code) Returns the severity of this message.void
Populates thisResource
from a URL.void
init
(ResourceDef.ResourceBundle resourceList, Locale locale) Populates thisResource
from an XML document.
-
Field Details
-
SEVERITY_INFO
static final int SEVERITY_INFO- See Also:
-
SEVERITY_ERR
static final int SEVERITY_ERR- See Also:
-
SEVERITY_WARN
static final int SEVERITY_WARN- See Also:
-
SEVERITY_NON_FATAL_ERR
static final int SEVERITY_NON_FATAL_ERR- See Also:
-
-
Method Details
-
init
Populates thisResource
from a URL.- Parameters:
url
- The URL of the XML file containing the error messageslocale
- The ISO locale code (e.g."en"
, or"en_US"
, or"en_US_WIN"
) of the messages- Throws:
IOException
- ifurl
cannot be opened, or if the format of its contents are invalidIOException
-
init
Populates thisResource
from an XML document.- Parameters:
resourceList
- The URL of the XML file containing the error messageslocale
- The ISO locale code (e.g."en"
, or"en_US"
, or"en_US_WIN"
) of the messages
-
getLocale
Locale getLocale()Returns the locale of the messages. -
formatError
Formats the message corresponding tocode
with the given arguments. If an argument is not supplied, the tokens remain in the returned message string. -
getSeverity
int getSeverity(int code) Returns the severity of this message.
-