Java Doc for Bundle.java in  » Internationalization-Localization » RBManager » com » ibm » rbm » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Internationalization Localization » RBManager » com.ibm.rbm 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.ibm.rbm.Bundle

Bundle
public class Bundle (Code)
A class representing the entire Bundle of Resources for a particular language, country, variant.
author:
   Jared Jackson
See Also:   com.ibm.rbm.RBManager


Field Summary
public  HashtableallItems
     A hashtable of all of the items in the bundle, hashed according to their NLS key.
public  Stringcomment
    
public  Stringcountry
     A descriptor of the country in the encoding (e.g.
public  Vectorduplicates
     A vector containing all of the items which are duplicates (based on the NLS keys) of items previously declared in the bundle.
public  Stringencoding
     The encoding of the bundle (e.g.
public  Stringlanguage
     A descriptor of the language in the encoding (e.g.
public  Stringmanager
    
public  Stringname
    
public  Stringvariant
     The descriptor of the variant in the encoding (e.g.

Constructor Summary
public  Bundle(String encoding)
    

Method Summary
public  voidaddBundleGroup(String groupName, String groupComment)
     Creates a group of the given name and optionally associates a comment with that group.
public  voidaddBundleGroup(BundleGroup bg)
    
public  voidaddBundleItem(BundleItem item)
     Add a bundle item to the bundle.
public  voidaddUntranslatedItem(BundleItem item)
     Attempts to add a BundleItem to the untranslatedItems.
public  BundleGroupgetBundleGroup(int index)
     Returns a bundle group given a certain index.
public  BundleGroupgetBundleGroup(String groupName)
     Looks for a bundle group of a given name within a bundle and returns it if found.
public  BundleItemgetBundleItem(String key)
     Looks up and returns a bundle item stored in the bundle based on its NLS lookup key.
public  StringgetCountryEncoding()
     Encodings are of the form -> language_country_variant <- (for example: "en_us_southern").
public  intgetGroupCount()
     Returns the number of groups in the bundle.
public  VectorgetGroupsAsVector()
     Return the various resource bundle groups stored in a Vector collection.
public  StringgetLanguageEncoding()
     Encodings are of the form -> language_country_variant <- (for example: "en_us_southern").
public  BundleGroupgetUngroupedGroup()
     One group is created for all bundles called 'Ungrouped Items'.
public  BundleItemgetUntranslatedItem(int index)
    
public  VectorgetUntranslatedItemsAsVector()
     Returns the UntranslatedItems as a vector.
public  intgetUntranslatedItemsSize()
    
public  StringgetVariantEncoding()
     Encodings are of the form -> language_country_variant <- (for example: "en_us_southern").
public  booleanhasGroup(String groupName)
    
public  voidremoveGroup(String groupName)
    
public  voidremoveItem(String key)
    
public  voidremoveUntranslatedItem(String name)
     Checks to see if an item of the given key name exists in the set of untranslated items.
public  voidremoveUntranslatedItemsByGroup(String groupName)
     Checks all items in the untranslated items set.
public  StringtoOutputString()
     This method produces a String which is suitable for inclusion in a .properties style resource bundle.
public  StringtoString()
     A method useful in debugging.
public  voidwriteContents(PrintStream ps)
     A helping method for outputting the formatted contents of the bundle to a print stream.
public  voidwriteContents(Writer w)
     A helping method for outputting the formatted contents of the bundle to a ouput Writer (such as a FileWriter).

Field Detail
allItems
public Hashtable allItems(Code)
A hashtable of all of the items in the bundle, hashed according to their NLS key.



comment
public String comment(Code)
A comment concerning the bundle



country
public String country(Code)
A descriptor of the country in the encoding (e.g. US, Canada, Great Britain)



duplicates
public Vector duplicates(Code)
A vector containing all of the items which are duplicates (based on the NLS keys) of items previously declared in the bundle.



encoding
public String encoding(Code)
The encoding of the bundle (e.g. 'en', 'en_US', 'de', etc.)



language
public String language(Code)
A descriptor of the language in the encoding (e.g. English, German, etc.)



manager
public String manager(Code)
The name of the person responsible for the managerment of this bundle



name
public String name(Code)
The following public class variables reflect the various properties that can be included as meta-data in a resource bundle formatted by RBManager



variant
public String variant(Code)
The descriptor of the variant in the encoding (e.g. Euro, Irish, etc.)




Constructor Detail
Bundle
public Bundle(String encoding)(Code)
Constructor for creating an empty bundle with a given encoding




Method Detail
addBundleGroup
public void addBundleGroup(String groupName, String groupComment)(Code)
Creates a group of the given name and optionally associates a comment with that group.



addBundleGroup
public void addBundleGroup(BundleGroup bg)(Code)
Add a bundle group to the bundle



addBundleItem
public void addBundleItem(BundleItem item)(Code)
Add a bundle item to the bundle. This bundle item should all ready have its bundle group assigned.



addUntranslatedItem
public void addUntranslatedItem(BundleItem item)(Code)
Attempts to add a BundleItem to the untranslatedItems. The addition will fail in two cases: One, if the item does not all ready belong to this Bundle, and Two, if the item is all ready in the set of untranslated items.



getBundleGroup
public BundleGroup getBundleGroup(int index)(Code)
Returns a bundle group given a certain index.



getBundleGroup
public BundleGroup getBundleGroup(String groupName)(Code)
Looks for a bundle group of a given name within a bundle and returns it if found.



getBundleItem
public BundleItem getBundleItem(String key)(Code)
Looks up and returns a bundle item stored in the bundle based on its NLS lookup key.



getCountryEncoding
public String getCountryEncoding()(Code)
Encodings are of the form -> language_country_variant <- (for example: "en_us_southern"). This method returns the country encoding string, or null if it is not specified



getGroupCount
public int getGroupCount()(Code)
Returns the number of groups in the bundle.



getGroupsAsVector
public Vector getGroupsAsVector()(Code)
Return the various resource bundle groups stored in a Vector collection.



getLanguageEncoding
public String getLanguageEncoding()(Code)
Encodings are of the form -> language_country_variant <- (for example: "en_us_southern"). This method returns the language encoding string, or null if it is not specified



getUngroupedGroup
public BundleGroup getUngroupedGroup()(Code)
One group is created for all bundles called 'Ungrouped Items'. This is the bundle group in which bundle items are placed that are not specifically grouped in the resource bundle file. This method returns that bundle group.



getUntranslatedItem
public BundleItem getUntranslatedItem(int index)(Code)
Returns the indexth untranslated item



getUntranslatedItemsAsVector
public Vector getUntranslatedItemsAsVector()(Code)
Returns the UntranslatedItems as a vector. I should find where this happens and stop it.



getUntranslatedItemsSize
public int getUntranslatedItemsSize()(Code)
Returns the number of items currently marked as untranslated



getVariantEncoding
public String getVariantEncoding()(Code)
Encodings are of the form -> language_country_variant <- (for example: "en_us_southern"). This method returns the variant encoding string, or null if it is not specified



hasGroup
public boolean hasGroup(String groupName)(Code)
Returns the boolean of wether a group of a given name exists in the bundle



removeGroup
public void removeGroup(String groupName)(Code)
Removes the group of the given name if it exists in the bundle



removeItem
public void removeItem(String key)(Code)
Removes a single resource item from the bundle



removeUntranslatedItem
public void removeUntranslatedItem(String name)(Code)
Checks to see if an item of the given key name exists in the set of untranslated items. If it does exist, then it is removed.



removeUntranslatedItemsByGroup
public void removeUntranslatedItemsByGroup(String groupName)(Code)
Checks all items in the untranslated items set. If they belong to a group whose name matches the passed in name, then they are removed.



toOutputString
public String toOutputString()(Code)
This method produces a String which is suitable for inclusion in a .properties style resource bundle. It attaches (in comments) the meta data that RBManager reads to manage the resource bundle file. This portion of the output should be included at the beginning of the resource bundle file.



toString
public String toString()(Code)
A method useful in debugging. The string returned displays the encoding information about the bundle and wether or not it is the base class of a resource bundle.



writeContents
public void writeContents(PrintStream ps)(Code)
A helping method for outputting the formatted contents of the bundle to a print stream. The method first outputs the header information and then outputs each bundle group's formatted data which includes each bundle item.



writeContents
public void writeContents(Writer w) throws IOException(Code)
A helping method for outputting the formatted contents of the bundle to a ouput Writer (such as a FileWriter). The method first outputs the header information and then outputs each bundle group's formatted data which includes each bundle item.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.