August 2009 - cal10n-dev - mailman3.qos.ch

Congratulations on a useful project; here's my suggestion
by Rick Beton 02 Sep '09

02 Sep '09

Hi, First of all, I'm new to this project and I'd like to congratulate you on putting it together with your typical no-nonsense approach to APIs. Particular praise is worthy for the IMessageConveyor interface hiding the ugliness of ResourceBundle and MessageFormat within a single method with varargs - inspired simplicity! Secondly, I would like to suggest a use-case that your API does not (yet?) cover. Maybe this is an idea you could consider incorporating. Within an enterprise application, especially a web-based application for example, resources frequently need to be looked up and corresponding strings returned to the user's display. But I have found that there are times in such applications where I would prefer to defer the choice of locale. For example, I may have some 'library' code not concerned with the UI yet which produces messages that are fed back to the user. These are status messages, error messages etc. The classic way to deal with these is to return separate transfer objects and later construct messages from them, but this can make the parameterisation awkward and adds complexity. Maybe it would be simpler to return the message directly. The problem with the Cal10n API as it stands is that I need to know the locale before I can construct a MessageConveyor. Only then can I call the getMessage(E e, Object... args) method to get the string, including its formatted parameters. The problem with web applications is that only the UI tier knows the locale. It is incorrect for other tiers to assume a different locale and unwieldy to pass the correct locale through as a parameter. So it would typically be wrong for the lower tiers to use MessageConveyor. This is a shame and my suggestion is simply that an additional data transfer object is required as part of the Cal10n API to fill the gap. This is essentially a Message class containing the enumeration and the args but without the resource bundle/message format lookup having yet been performed. At a later stage, a getLocalizedMessage(Locale locale) method will yield the required String for a given locale. A desirable characteristic of Message is that it be immutable because this would make it safe to hold within Exceptions or to be shared between threads. In other words, it would be better for it not to be a classic mutable JavaBean data transfer object. Therefore it is arguable that a general interface is not needed and a concrete and final Message class would be completely sufficient. So here is a possible implementation for Message: public final class Message { private final Enum<?> e; private final Object[] args; public Message(Enum<?> e, Object... args) { this.e = e; this.args = args; } public String getLocalizedMessage(Locale locale) { final IMessageConveyor mc = new MessageConveyor(locale); return mc.getMessage(e, args); } @Override public String toString() { final StringBuilder b = new StringBuilder("Message("); b.append(e.name()); b.append(", ["); if (args != null) { String comma = ""; for (Object o : args) { b.append(comma).append(o); comma = ", "; } } b.append("])"); return b.toString(); } } In use, the 'library' (non-UI) code will have its own resource bundle and corresponding enum. It will create instances of Message to return to the UI tier, where the message string for the appropriate locale can be looked up and then presented to the user. It would be beneficial to override hashcode() and equals() methods appropriately but I haven't included that here. There may also be some performance value in holding transient caches of the toString() result and the hashcode, although I omitted this also. I wish the project success and I look forward to recommending it to my clients when it reaches a sufficient level of maturity. Regards, Rick Beton -- Big Bee Consultants Limited : Registered in England & Wales No. 6397941 Registered Office: 71 The Hundred, Romsey, Hampshire, SO51 8BZ

3 10

[GIT] Compiler assisted localization library branch, master, updated. 27f1ec582de95317643cc8004bbe18672bb31e07
by git-noreply＠pixie.qos.ch 31 Aug '09

31 Aug '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The branch, master has been updated via 27f1ec582de95317643cc8004bbe18672bb31e07 (commit) from 6d8150c8fd78796ff2b5db2baf703ccd350fedd1 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=27f1ec582de95317643cc8004… http://github.com/ceki/cal10n/commit/27f1ec582de95317643cc8004bbe18672bb31e… commit 27f1ec582de95317643cc8004bbe18672bb31e07 Author: Sebastien Pennec <ceki(a)qos.ch> Date: Mon Aug 31 22:25:19 2009 +0200 - experimenting with class loading on linux diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java index 0146e1f..2be14a8 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java @@ -49,10 +49,14 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { this.enumTypeAsStr = enumClass.getName(); } + public MessageCodeVerifier() { + System.out.println("lkkkkkkkkkkkkkk="+this.getClass().getClassLoader()); + } @SuppressWarnings("unchecked") public MessageCodeVerifier(String enumTypeAsStr) { this.enumTypeAsStr = enumTypeAsStr; String errMsg = "Failed to find enum class [" + enumTypeAsStr + "]"; + System.out.println("lkkkkkkkkkkkkkk="+this.getClass().getClassLoader()); try { this.enumType = (Class<? extends Enum<?>>) Class.forName(enumTypeAsStr); } catch (ClassNotFoundException e) { diff --git a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java index 2575157..8a702ce 100644 --- a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java @@ -27,6 +27,7 @@ import java.net.MalformedURLException; import java.net.URL; import java.net.URLClassLoader; import java.util.ArrayList; +import java.util.Arrays; import java.util.List; import java.util.Locale; import java.util.Set; @@ -147,6 +148,7 @@ public class VerifyMojo extends AbstractMojo { URLClassLoader cl = (URLClassLoader) buildClassLoader(); Class<?> cla = Class.forName(Cal10nConstants.MessageCodeVerifier_FQCN, true, cl); + cla.newInstance(); Constructor<?> cons = cla.getConstructor(String.class); IMessageCodeVerifier imcv = (IMessageCodeVerifier) cons @@ -162,11 +164,14 @@ public class VerifyMojo extends AbstractMojo { } ClassLoader buildClassLoader() { - ArrayList<URL> classpathURLArray = new ArrayList<URL>(); - classpathURLArray.add(toURL(outputDirectory)); - classpathURLArray.addAll(getDirectDependencies()); + ArrayList<URL> classpathURLList = new ArrayList<URL>(); + classpathURLList.add(toURL(outputDirectory)); + classpathURLList.addAll(getDirectDependencies()); ClassLoader parentCL = this.getClass().getClassLoader(); - return new ThisFirstClassLoader(classpathURLArray.toArray(new URL[] {}), parentCL); + + URL[] classpathURLArray = classpathURLList.toArray(new URL[] {}); + System.out.println("classpathURLArray="+Arrays.toString(classpathURLArray)); + return new ThisFirstClassLoader(classpathURLArray, parentCL); } List<URL> getDirectDependencies() { @@ -179,7 +184,7 @@ public class VerifyMojo extends AbstractMojo { URL url = new URL("file:/" + pathOfArtifact); urlList.add(url); } catch (MalformedURLException e) { - e.printStackTrace(); + getLog().info("Failed to build URL", e); } } return urlList; ----------------------------------------------------------------------- Summary of changes: .../qos/cal10n/verifier/MessageCodeVerifier.java | 4 ++++ .../java/ch/qos/cal10n/plugins/VerifyMojo.java | 15 ++++++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0

Congratulations on a useful project; here's my suggestion
by Rick Beton 31 Aug '09

31 Aug '09

Hi, First of all, I'm new to this project and I'd like to congratulate you on putting it together with your typical no-nonsense approach to APIs. Particular praise is worthy for the IMessageConveyor interface hiding the ugliness of ResourceBundle and MessageFormat within a single method with varargs - inspired simplicity! Secondly, I would like to suggest a use-case that your API does not (yet?) cover. Maybe this is an idea you could consider incorporating. Within an enterprise application, especially a web-based application for example, resources frequently need to be looked up and corresponding strings returned to the user's display. But I have found that there are times in such applications where I would prefer to defer the choice of locale. For example, I may have some 'library' code not concerned with the UI yet which produces messages that are fed back to the user. These are status messages, error messages etc. The classic way to deal with these is to return separate transfer objects and later construct messages from them, but this can make the parameterisation awkward and adds complexity. Maybe it would be simpler to return the message directly. The problem with the Cal10n API as it stands is that I need to know the locale before I can construct a MessageConveyor. Only then can I call the getMessage(E e, Object... args) method to get the string, including its formatted parameters. The problem with web applications is that only the UI tier knows the locale. It is incorrect for other tiers to assume a different locale and unwieldy to pass the correct locale through as a parameter. So it would typically be wrong for the lower tiers to use MessageConveyor. This is a shame and my suggestion is simply that an additional data transfer object is required as part of the Cal10n API to fill the gap. This is essentially a Message class containing the enumeration and the args but without the resource bundle/message format lookup having yet been performed. At a later stage, a getLocalizedMessage(Locale locale) method will yield the required String for a given locale. A desirable characteristic of Message is that it be immutable because this would make it safe to hold within Exceptions or to be shared between threads. In other words, it would be better for it not to be a classic mutable JavaBean data transfer object. Therefore it is arguable that a general interface is not needed and a concrete and final Message class would be completely sufficient. So here is a possible implementation for Message: public final class Message { private final Enum<?> e; private final Object[] args; public Message(Enum<?> e, Object... args) { this.e = e; this.args = args; } public String getLocalizedMessage(Locale locale) { final IMessageConveyor mc = new MessageConveyor(locale); return mc.getMessage(e, args); } @Override public String toString() { final StringBuilder b = new StringBuilder("Message("); b.append(e.name()); b.append(", ["); if (args != null) { String comma = ""; for (Object o : args) { b.append(comma).append(o); comma = ", "; } } b.append("])"); return b.toString(); } } In use, the 'library' (non-UI) code will have its own resource bundle and corresponding enum. It will create instances of Message to return to the UI tier, where the message string for the appropriate locale can be looked up and then presented to the user. It would be beneficial to override hashcode() and equals() methods appropriately but I haven't included that here. There may also be some performance value in holding transient caches of the toString() result and the hashcode, although I omitted this also. I wish the project success and I look forward to recommending it to my clients when it reaches a sufficient level of maturity. Regards, Rick Beton -- Big Bee Consultants Limited : Registered in England & Wales No. 6397941 Registered Office: 71 The Hundred, Romsey, Hampshire, SO51 8BZ

2 1

[GIT] Compiler assisted localization library branch, master, updated. 6d8150c8fd78796ff2b5db2baf703ccd350fedd1
by git-noreply＠pixie.qos.ch 28 Aug '09

28 Aug '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The branch, master has been updated via 6d8150c8fd78796ff2b5db2baf703ccd350fedd1 (commit) from 05054e0444ffb2f12e872153515cf23ec11f8e17 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=6d8150c8fd78796ff2b5db2ba… http://github.com/ceki/cal10n/commit/6d8150c8fd78796ff2b5db2baf703ccd350fed… commit 6d8150c8fd78796ff2b5db2baf703ccd350fedd1 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Aug 28 23:29:14 2009 +0200 testing notifications diff --git a/maven-cal10n-plugin/pom.xml b/maven-cal10n-plugin/pom.xml index d4b30a6..322ad2d 100644 --- a/maven-cal10n-plugin/pom.xml +++ b/maven-cal10n-plugin/pom.xml @@ -19,6 +19,7 @@ <name> Compiler assisted localization library (CAL10N) - Maven</name> <url>http://cal10n.qos.ch</url> + <dependencies> <dependency> <groupId>org.apache.maven</groupId> ----------------------------------------------------------------------- Summary of changes: maven-cal10n-plugin/pom.xml | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0

testing the archives
by Ceki Gulcu 28 Aug '09

28 Aug '09

-- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://logback.qos.ch

1 0

[cai18n-dev] CAL10N instead of CAI18N ?
by Ceki Gulcu 28 Aug '09

28 Aug '09

Hello all, It dawned on me that CAL10N, which can be pronounced as "callon" is a nicer project name than CAI18N which is quite hard to pronounce. L10N is the abbreviation for localization... Comments? -- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://logback.qos.ch

2 2

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. v0.3-3-gf4cf185
by git-noreply＠pixie.qos.ch 28 Aug '09

28 Aug '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted internalization library". The branch, master has been updated via f4cf18576cb325ba21219b2b7e6a87086bb48f69 (commit) via 6cbd6d487b85a10a1264655f80c148e0694155ed (commit) via 757d2b84c9d3f73608cbfed156ac8b74538bde82 (commit) from 4e73aefc83f9f6c2462c18fb49e24d588bafbde5 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cai18n.git;a=commit;h=f4cf18576cb325ba21219b2b7… http://github.com/ceki/cai18n/commit/f4cf18576cb325ba21219b2b7e6a87086bb48f… commit f4cf18576cb325ba21219b2b7e6a87086bb48f69 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Aug 28 19:56:50 2009 +0200 - last remaining traces of CAI18N diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java index 84b5116..05a67a4 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java @@ -2,7 +2,7 @@ package ch.qos.cal10n; /** * - * This class defines the shared constants in CAI18N. + * This class defines the shared constants in CAL10N. * * @author Ceki Gülcü * diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/package.html b/cal10n-api/src/main/java/ch/qos/cal10n/package.html index a3a71a7..c2d3988 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/package.html +++ b/cal10n-api/src/main/java/ch/qos/cal10n/package.html @@ -7,7 +7,7 @@ <body> -<p>The main package of the CAI18N project.</p> +<p>The main package of the CAL10N project.</p> <p>It contains the {@link IMessageConveyor} interface and the default implementation {@link MessageConveyor}. diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/util/package.html b/cal10n-api/src/main/java/ch/qos/cal10n/util/package.html index 271f684..d1d3592 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/util/package.html +++ b/cal10n-api/src/main/java/ch/qos/cal10n/util/package.html @@ -7,7 +7,7 @@ <body> -<p>Package containing utility classes, used internally by the CAI18N +<p>Package containing utility classes, used internally by the CAL10N project.</p> diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java index 45d9a45..8dcd11a 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java @@ -62,21 +62,21 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { /* (non-Javadoc) - * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#getEnumType() + * @see ch.qos.cai10n.verifier.IIMessageCodeVerifier#getEnumType() */ public Class<? extends Enum<?>> getEnumType() { return enumType; } /* (non-Javadoc) - * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#getEnumTypeAsStr() + * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#getEnumTypeAsStr() */ public String getEnumTypeAsStr() { return enumTypeAsStr; } /* (non-Javadoc) - * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#verify(java.util.Locale) + * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#verify(java.util.Locale) */ public List<Cal10nError> verify(Locale locale) { List<Cal10nError> errorList = new ArrayList<Cal10nError>(); @@ -130,7 +130,7 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { } /* (non-Javadoc) - * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#typeIsolatedVerify(java.util.Locale) + * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#typeIsolatedVerify(java.util.Locale) */ public List<String> typeIsolatedVerify(Locale locale) { List<Cal10nError> errorList = verify(locale); @@ -165,7 +165,7 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { /* (non-Javadoc) - * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#getLocaleNames() + * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#getLocaleNames() */ public String[] getLocaleNames() { String[] localeNameArray = AnnotationExtractor.getLocaleNames(enumType); diff --git a/cal10n-site/src/site/pages/documentation.html b/cal10n-site/src/site/pages/documentation.html index 5fed997..d1386ea 100644 --- a/cal10n-site/src/site/pages/documentation.html +++ b/cal10n-site/src/site/pages/documentation.html @@ -20,13 +20,13 @@ <div id="content"> - <h2>CAI18M documentation</h2> + <h2>CAL10N documentation</h2> <p>Below is a list of logback-related documentaiton currently available.</p> <ul> - <li><a href="manual.html"><b>The CAI18N manual</b></a></li> + <li><a href="manual.html"><b>The CAL10N manual</b></a></li> </ul> <p>Source code related documentation:</p> diff --git a/cal10n-site/src/site/pages/index.html b/cal10n-site/src/site/pages/index.html index b14e7b6..1d9c86d 100644 --- a/cal10n-site/src/site/pages/index.html +++ b/cal10n-site/src/site/pages/index.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> - <title>CAI18N Home</title> + <title>CAL10N Home</title> <link rel="stylesheet" type="text/css" href="css/common.css" /> <link rel="stylesheet" type="text/css" href="css/screen.css" media="screen" /> <link rel="stylesheet" type="text/css" href="css/_print.css" media="print" /> diff --git a/cal10n-site/src/site/pages/license.html b/cal10n-site/src/site/pages/license.html index 2fed136..01fe451 100644 --- a/cal10n-site/src/site/pages/license.html +++ b/cal10n-site/src/site/pages/license.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> - <title>CAI18N Home</title> + <title>License</title> <link rel="stylesheet" type="text/css" href="css/common.css" /> <link rel="stylesheet" type="text/css" href="css/screen.css" media="screen" /> <link rel="stylesheet" type="text/css" href="css/_print.css" media="print" /> diff --git a/cal10n-site/src/site/pages/manual.html b/cal10n-site/src/site/pages/manual.html index cc916c5..a4c60b1 100644 --- a/cal10n-site/src/site/pages/manual.html +++ b/cal10n-site/src/site/pages/manual.html @@ -4,7 +4,7 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> - <title>CAI18N Manual</title> + <title>Manual</title> <link rel="stylesheet" type="text/css" href="css/common.css" /> <link rel="stylesheet" type="text/css" href="css/screen.css" media="screen" /> <link rel="stylesheet" type="text/css" href="css/_print.css" media="print" /> diff --git a/cal10n-site/src/site/pages/templates/header.js b/cal10n-site/src/site/pages/templates/header.js index 84137ba..89c580d 100644 --- a/cal10n-site/src/site/pages/templates/header.js +++ b/cal10n-site/src/site/pages/templates/header.js @@ -1,7 +1,7 @@ document.write('<p align="left">'); -document.write('<a href="http://cai18n.qos.ch/">'); -document.write('<img src="' + prefix + 'images/CAI18N_logo.gif" alt="" border="0" style="margin-left: 4px; " />'); +document.write('<a href="http://cal10n.qos.ch/">'); +document.write('<img src="' + prefix + 'images/CAL10N_logo.gif" alt="" border="0" style="margin-left: 4px; " />'); document.write('</a>') document.write('</p>'); document.write('<div id="headerLine"></div>'); diff --git a/cal10n-site/src/site/pages/templates/left.js b/cal10n-site/src/site/pages/templates/left.js index db02ffd..ab10619 100644 --- a/cal10n-site/src/site/pages/templates/left.js +++ b/cal10n-site/src/site/pages/templates/left.js @@ -1,5 +1,5 @@ -document.write('<p class="menu_header">CAI18N project</p>'); +document.write('<p class="menu_header">CAL10N project</p>'); document.write('<p class="menu"><a href="' + prefix + 'index.html">Introduction</a></p>'); document.write('<p class="menu"><a href="' + prefix + 'news.html">News</a></p>'); document.write('<p class="menu"><a href="' + prefix + 'download.html">Download</a></p>'); http://git.qos.ch/gitweb/?p=cai18n.git;a=commit;h=6cbd6d487b85a10a1264655f8… http://github.com/ceki/cai18n/commit/6cbd6d487b85a10a1264655f80c148e0694155… commit 6cbd6d487b85a10a1264655f80c148e0694155ed Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Aug 28 19:47:01 2009 +0200 - renamed project CAI18N as CAI10N diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java b/cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java deleted file mode 100644 index 794bc49..0000000 --- a/cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java +++ /dev/null @@ -1,15 +0,0 @@ -package ch.qos.cai18n; - -/** - * - * This class defines the shared constants in CAI18N. - * - * @author Ceki Gülcü - * - */ -public class Cai18nConstants { - - final public static String CODE_URL_PREFIX = "http://cai18n.qos.ch/codes.html"; - final public static String MISSING_RB_ANNOTATION_URL = Cai18nConstants.CODE_URL_PREFIX+"#missingRBAnnotation"; - -} diff --git a/cai18n-api/LICENSE.txt b/cal10n-api/LICENSE.txt similarity index 100% rename from cai18n-api/LICENSE.txt rename to cal10n-api/LICENSE.txt diff --git a/cai18n-api/pom.xml b/cal10n-api/pom.xml similarity index 62% rename from cai18n-api/pom.xml rename to cal10n-api/pom.xml index 2b491f6..0adb284 100644 --- a/cai18n-api/pom.xml +++ b/cal10n-api/pom.xml @@ -3,16 +3,16 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-parent</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-parent</artifactId> <version>0.3</version> </parent> <modelVersion>4.0.0</modelVersion> - <artifactId>cai18n-api</artifactId> + <artifactId>cal10n-api</artifactId> <packaging>jar</packaging> - <name>Compiler assisted internationalization library (CAI18N) - API</name> + <name>Compiler assisted localization library (CAL10N) - API</name> <dependencies> </dependencies> diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java new file mode 100644 index 0000000..84b5116 --- /dev/null +++ b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java @@ -0,0 +1,16 @@ +package ch.qos.cal10n; + +/** + * + * This class defines the shared constants in CAI18N. + * + * @author Ceki Gülcü + * + */ +public class Cal10nConstants { + + final public static String CODE_URL_PREFIX = "http://cal10n.qos.ch/codes.html"; + final public static String MISSING_RB_ANNOTATION_URL = Cal10nConstants.CODE_URL_PREFIX+"#missingRBAnnotation"; + + final public static String MessageCodeVerifier_FQCN = "ch.qos.cal10n.verifier.MessageCodeVerifier"; +} diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java similarity index 96% rename from cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java rename to cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java index 521bfe4..f54c19d 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java @@ -20,7 +20,7 @@ * SOFTWARE. */ -package ch.qos.cai18n; +package ch.qos.cal10n; import java.text.MessageFormat; diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java similarity index 94% rename from cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java rename to cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java index 1ee5d1f..46c4832 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java @@ -19,14 +19,14 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n; +package ch.qos.cal10n; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; /** * This annotation serves to designate a list of locale names for which resource diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java similarity index 92% rename from cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java rename to cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java index 8233741..c061195 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java @@ -20,13 +20,13 @@ * SOFTWARE. */ -package ch.qos.cai18n; +package ch.qos.cal10n; import java.text.MessageFormat; import java.util.Locale; import java.util.ResourceBundle; -import ch.qos.cai18n.util.AnnotationExtractor; +import ch.qos.cal10n.util.AnnotationExtractor; /** * The default implementation for {@link IMessageConveyor} based on resource @@ -70,7 +70,7 @@ public class MessageConveyor implements IMessageConveyor { if (resouceBundleName == null) { throw new IllegalArgumentException( "Missing ResourceBundleAnnotation in [" + e.getClass().getName() - + "]. See also " + Cai18nConstants.MISSING_RB_ANNOTATION_URL); + + "]. See also " + Cal10nConstants.MISSING_RB_ANNOTATION_URL); } ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java b/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java similarity index 94% rename from cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java rename to cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java index 788567a..a865d1d 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n; +package ch.qos.cal10n; import java.lang.annotation.ElementType; @@ -27,7 +27,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; /** * This annotation serves to designate the name of the resource bundle diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/package.html b/cal10n-api/src/main/java/ch/qos/cal10n/package.html similarity index 100% rename from cai18n-api/src/main/java/ch/qos/cai18n/package.html rename to cal10n-api/src/main/java/ch/qos/cal10n/package.html diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java b/cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java similarity index 92% rename from cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java rename to cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java index e8bff49..0b917f4 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java @@ -19,10 +19,10 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.util; +package ch.qos.cal10n.util; -import ch.qos.cai18n.LocaleNames; -import ch.qos.cai18n.ResourceBundleName; +import ch.qos.cal10n.LocaleNames; +import ch.qos.cal10n.ResourceBundleName; /** * diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/util/package.html b/cal10n-api/src/main/java/ch/qos/cal10n/util/package.html similarity index 100% rename from cai18n-api/src/main/java/ch/qos/cai18n/util/package.html rename to cal10n-api/src/main/java/ch/qos/cal10n/util/package.html diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java similarity index 93% rename from cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java index a1b3b2a..5bad0aa 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.verifier; +package ch.qos.cal10n.verifier; import java.util.Locale; @@ -30,7 +30,7 @@ import java.util.Locale; * * @author Ceki Gülcü */ -public class Cai18nError { +public class Cal10nError { enum ErrorType { // MISSING_LOCALE_NAMES_ANNOTATION @@ -45,7 +45,7 @@ public class Cai18nError { final String enumClassName; final String resouceBundleName; - Cai18nError(ErrorType errorType, String code, Class<?> enumClass, + Cal10nError(ErrorType errorType, String code, Class<?> enumClass, Locale locale, String resourceBundleName) { this.errorType = errorType; this.code = code; diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java similarity index 83% rename from cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java index ddc1a85..6445b2b 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java @@ -19,14 +19,14 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.verifier; +package ch.qos.cal10n.verifier; import java.util.Locale; -import ch.qos.cai18n.verifier.Cai18nError.ErrorType; +import ch.qos.cal10n.verifier.Cal10nError.ErrorType; /** - * Simplifies the creation of {@link Cai18nError} instances. + * Simplifies the creation of {@link Cal10nError} instances. * * @author Ceki Gülcü * @@ -44,8 +44,8 @@ public class ErrorFactory { this.resourceBundleName = resourceBundleName; } - Cai18nError buildError(ErrorType errorType, String code) { - return new Cai18nError(errorType, code, enumClass, locale, + Cal10nError buildError(ErrorType errorType, String code) { + return new Cal10nError(errorType, code, enumClass, locale, resourceBundleName); } } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/IMessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageCodeVerifier.java similarity index 89% rename from cai18n-api/src/main/java/ch/qos/cai18n/verifier/IMessageCodeVerifier.java rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageCodeVerifier.java index 19a65d4..de30c9a 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/IMessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageCodeVerifier.java @@ -1,4 +1,4 @@ -package ch.qos.cai18n.verifier; +package ch.qos.cal10n.verifier; import java.util.List; import java.util.Locale; @@ -40,7 +40,7 @@ public interface IMessageCodeVerifier { * @param locale * @return */ - public List<Cai18nError> verify(Locale locale); + public List<Cal10nError> verify(Locale locale); /** * Verify that the keys defined in the enumClass match those found in the @@ -50,7 +50,7 @@ public interface IMessageCodeVerifier { * @param locale * @return */ - public List<Cai18nError> verifyAllLocales(); + public List<Cal10nError> verifyAllLocales(); /** * Same as {@link #verify(Locale)} except that the return type is diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java similarity index 87% rename from cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java index 35bd09f..45d9a45 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java @@ -20,7 +20,7 @@ * SOFTWARE. */ -package ch.qos.cai18n.verifier; +package ch.qos.cal10n.verifier; import java.util.ArrayList; import java.util.List; @@ -28,8 +28,8 @@ import java.util.Locale; import java.util.ResourceBundle; import java.util.Set; -import ch.qos.cai18n.util.AnnotationExtractor; -import ch.qos.cai18n.verifier.Cai18nError.ErrorType; +import ch.qos.cal10n.util.AnnotationExtractor; +import ch.qos.cal10n.verifier.Cal10nError.ErrorType; /** * Given an enum class, verify that the resource bundles corresponding to a @@ -78,14 +78,14 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { /* (non-Javadoc) * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#verify(java.util.Locale) */ - public List<Cai18nError> verify(Locale locale) { - List<Cai18nError> errorList = new ArrayList<Cai18nError>(); + public List<Cal10nError> verify(Locale locale) { + List<Cal10nError> errorList = new ArrayList<Cal10nError>(); String resouceBundleName = AnnotationExtractor .getResourceBundleName(enumType); if (resouceBundleName == null) { - errorList.add(new Cai18nError(ErrorType.MISSING_RBN_ANNOTATION, "", + errorList.add(new Cal10nError(ErrorType.MISSING_RBN_ANNOTATION, "", enumType, locale, "")); // no point in continuing return errorList; @@ -133,9 +133,9 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { * @see ch.qos.cai18n.verifier.IIMessageCodeVerifier#typeIsolatedVerify(java.util.Locale) */ public List<String> typeIsolatedVerify(Locale locale) { - List<Cai18nError> errorList = verify(locale); + List<Cal10nError> errorList = verify(locale); List<String> strList = new ArrayList<String>(); - for (Cai18nError error : errorList) { + for (Cal10nError error : errorList) { strList.add(error.toString()); } return strList; @@ -144,8 +144,8 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { /*** * Verify all declared locales in one step. */ - public List<Cai18nError> verifyAllLocales() { - List<Cai18nError> errorList = new ArrayList<Cai18nError>(); + public List<Cal10nError> verifyAllLocales() { + List<Cal10nError> errorList = new ArrayList<Cal10nError>(); String[] localeNameArray = getLocaleNames(); @@ -156,7 +156,7 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { } for (String localeName : localeNameArray) { Locale locale = new Locale(localeName); - List<Cai18nError> tmpList = verify(locale); + List<Cal10nError> tmpList = verify(locale); errorList.addAll(tmpList); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/package.html b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/package.html similarity index 100% rename from cai18n-api/src/main/java/ch/qos/cai18n/verifier/package.html rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/package.html diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/AllCal10nTest.java similarity index 87% rename from cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/AllCal10nTest.java index 0047679..4a9a34e 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/AllCal10nTest.java @@ -20,15 +20,15 @@ * SOFTWARE. */ -package ch.qos.cai18n; +package ch.qos.cal10n; import org.junit.runner.RunWith; import org.junit.runners.Suite; import org.junit.runners.Suite.SuiteClasses; @RunWith(Suite.class) -(a)SuiteClasses({ch.qos.cai18n.util.PackageTest.class, - ch.qos.cai18n.sample.PackageTest.class}) -public class AllCai18nTest { +(a)SuiteClasses({ch.qos.cal10n.util.PackageTest.class, + ch.qos.cal10n.sample.PackageTest.class}) +public class AllCal10nTest { } diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java similarity index 90% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java index f4a59e3..4248147 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java @@ -20,10 +20,10 @@ * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; -import ch.qos.cai18n.LocaleNames; -import ch.qos.cai18n.ResourceBundleName; +import ch.qos.cal10n.LocaleNames; +import ch.qos.cal10n.ResourceBundleName; @ResourceBundleName("colors") @LocaleNames({"en_UK", "fr"}) diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java similarity index 90% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java index 8cab228..626c621 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java @@ -19,10 +19,10 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; -import ch.qos.cai18n.LocaleNames; -import ch.qos.cai18n.ResourceBundleName; +import ch.qos.cal10n.LocaleNames; +import ch.qos.cal10n.ResourceBundleName; @ResourceBundleName("countries") @LocaleNames({"en", "fr"}) diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java similarity index 83% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java index d2e67ea..847c368 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java @@ -20,7 +20,7 @@ * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; import static org.junit.Assert.assertEquals; @@ -29,9 +29,9 @@ import java.util.Locale; import org.junit.Test; -import ch.qos.cai18n.verifier.Cai18nError; -import ch.qos.cai18n.verifier.IMessageCodeVerifier; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.Cal10nError; +import ch.qos.cal10n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; /** * @@ -43,14 +43,14 @@ public class MessageCodeVerifierTest { @Test public void smoke() { IMessageCodeVerifier miv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = miv.verify(Locale.UK); + List<Cal10nError> errorList = miv.verify(Locale.UK); assertEquals(0, errorList.size()); } @Test public void withErrors_UK() { IMessageCodeVerifier miv = new MessageCodeVerifier(Countries.class); - List<Cai18nError> errorList = miv.verify(Locale.UK); + List<Cal10nError> errorList = miv.verify(Locale.UK); assertEquals(2, errorList.size()); assertEquals("CH", errorList.get(0).getCode()); assertEquals("BR", errorList.get(1).getCode()); @@ -60,7 +60,7 @@ public class MessageCodeVerifierTest { @Test public void withErrors_FR() { IMessageCodeVerifier miv = new MessageCodeVerifier(Countries.class); - List<Cai18nError> errorList = miv.verify(Locale.FRANCE); + List<Cal10nError> errorList = miv.verify(Locale.FRANCE); assertEquals(3, errorList.size()); assertEquals("CH", errorList.get(0).getCode()); assertEquals("CN", errorList.get(1).getCode()); diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageConveyorTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java similarity index 93% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageConveyorTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java index 94bb2e2..dfc2219 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageConveyorTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java @@ -20,7 +20,7 @@ * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; import static org.junit.Assert.assertEquals; @@ -28,7 +28,7 @@ import java.util.Locale; import org.junit.Test; -import ch.qos.cai18n.MessageConveyor; +import ch.qos.cal10n.MessageConveyor; public class MessageConveyorTest { diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MyAllInOneColorVerificationTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java similarity index 83% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/MyAllInOneColorVerificationTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java index 0b0b2ad..80b30db 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MyAllInOneColorVerificationTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; import static org.junit.Assert.assertEquals; @@ -28,9 +28,9 @@ import java.util.List; import org.junit.Test; -import ch.qos.cai18n.verifier.Cai18nError; -import ch.qos.cai18n.verifier.IMessageCodeVerifier; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.Cal10nError; +import ch.qos.cal10n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; /** * @@ -43,7 +43,7 @@ public class MyAllInOneColorVerificationTest { @Test public void all() { IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = mcv.verifyAllLocales(); + List<Cal10nError> errorList = mcv.verifyAllLocales(); assertEquals(0, errorList.size()); } diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MyColorVerificationTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java similarity index 79% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/MyColorVerificationTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java index 12f94c2..3b8f7ab 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MyColorVerificationTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; import static org.junit.Assert.assertEquals; @@ -29,17 +29,17 @@ import java.util.Locale; import org.junit.Test; -import ch.qos.cai18n.verifier.Cai18nError; -import ch.qos.cai18n.verifier.IMessageCodeVerifier; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.Cal10nError; +import ch.qos.cal10n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; public class MyColorVerificationTest { @Test public void en_UK() { IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = mcv.verify(Locale.UK); - for(Cai18nError error: errorList) { + List<Cal10nError> errorList = mcv.verify(Locale.UK); + for(Cal10nError error: errorList) { System.out.println(error); } assertEquals(0, errorList.size()); @@ -48,8 +48,8 @@ public class MyColorVerificationTest { @Test public void fr() { IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = mcv.verify(Locale.FRANCE); - for(Cai18nError error: errorList) { + List<Cal10nError> errorList = mcv.verify(Locale.FRANCE); + for(Cal10nError error: errorList) { System.out.println(error); } assertEquals(0, errorList.size()); diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java similarity index 95% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java index 499c65e..206b651 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java @@ -20,7 +20,7 @@ * SOFTWARE. */ -package ch.qos.cai18n.sample; +package ch.qos.cal10n.sample; import org.junit.runner.RunWith; import org.junit.runners.Suite; diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnotationExtractorTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java similarity index 93% rename from cai18n-api/src/test/java/ch/qos/cai18n/util/AnnotationExtractorTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java index 5d7efb2..0d4cd40 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnotationExtractorTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.util; +package ch.qos.cal10n.util; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; @@ -28,6 +28,8 @@ import java.util.Arrays; import org.junit.Test; +import ch.qos.cal10n.util.AnnotationExtractor; + public class AnnotationExtractorTest { diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/util/Fruit.java b/cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java similarity index 90% rename from cai18n-api/src/test/java/ch/qos/cai18n/util/Fruit.java rename to cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java index 610077b..b0c70af 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/util/Fruit.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java @@ -19,10 +19,10 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.util; +package ch.qos.cal10n.util; -import ch.qos.cai18n.LocaleNames; -import ch.qos.cai18n.ResourceBundleName; +import ch.qos.cal10n.LocaleNames; +import ch.qos.cal10n.ResourceBundleName; @ResourceBundleName("fruits") @LocaleNames({"fr", "en"}) diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/util/PackageTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/util/PackageTest.java similarity index 95% rename from cai18n-api/src/test/java/ch/qos/cai18n/util/PackageTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/util/PackageTest.java index 128dfc0..fa5217e 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/util/PackageTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/util/PackageTest.java @@ -20,7 +20,7 @@ * SOFTWARE. */ -package ch.qos.cai18n.util; +package ch.qos.cal10n.util; import org.junit.runner.RunWith; import org.junit.runners.Suite; diff --git a/cai18n-api/src/test/resources/colors_en.properties b/cal10n-api/src/test/resources/colors_en.properties similarity index 100% rename from cai18n-api/src/test/resources/colors_en.properties rename to cal10n-api/src/test/resources/colors_en.properties diff --git a/cai18n-api/src/test/resources/colors_fr.properties b/cal10n-api/src/test/resources/colors_fr.properties similarity index 100% rename from cai18n-api/src/test/resources/colors_fr.properties rename to cal10n-api/src/test/resources/colors_fr.properties diff --git a/cai18n-api/src/test/resources/countries_en.properties b/cal10n-api/src/test/resources/countries_en.properties similarity index 100% rename from cai18n-api/src/test/resources/countries_en.properties rename to cal10n-api/src/test/resources/countries_en.properties diff --git a/cai18n-api/src/test/resources/countries_fr.properties b/cal10n-api/src/test/resources/countries_fr.properties similarity index 100% rename from cai18n-api/src/test/resources/countries_fr.properties rename to cal10n-api/src/test/resources/countries_fr.properties diff --git a/cai18n-site/LICENSE.txt b/cal10n-site/LICENSE.txt similarity index 100% rename from cai18n-site/LICENSE.txt rename to cal10n-site/LICENSE.txt diff --git a/cai18n-site/pom.xml b/cal10n-site/pom.xml similarity index 80% rename from cai18n-site/pom.xml rename to cal10n-site/pom.xml index b9f03d3..4cfd3bd 100644 --- a/cai18n-site/pom.xml +++ b/cal10n-site/pom.xml @@ -3,18 +3,18 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-parent</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-parent</artifactId> <version>0.3</version> </parent> <modelVersion>4.0.0</modelVersion> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-site</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-site</artifactId> <packaging>jar</packaging> - <name>Compiler assisted internationalization library (CAI18N) - Site</name> + <name>Compiler assisted localization library (CAL10N) - Site</name> <build> diff --git a/cai18n-site/src/site/pages/bugreport.html b/cal10n-site/src/site/pages/bugreport.html similarity index 91% rename from cai18n-site/src/site/pages/bugreport.html rename to cal10n-site/src/site/pages/bugreport.html index 6df9971..1ccdebf 100644 --- a/cai18n-site/src/site/pages/bugreport.html +++ b/cal10n-site/src/site/pages/bugreport.html @@ -22,14 +22,14 @@ <h2>Before you report a bug</h2> - <p>The cai18n community consists of those who use cai18n and its + <p>The cal10n community consists of those who use cal10n and its modules, help answer questions on discussions lists, contribute documentation and patches, and those who develop and maintain its code. Almost all those who assist on a day to day basis resolving bug reports do this for a wide variety of reasons, and almost all of them do this on their own time.</p> - <p>Many bugs reported end up not being a bug in cai18n, but are + <p>Many bugs reported end up not being a bug in cal10n, but are due to misconfiguration, problems caused by installed applications, the operating system, etc. </p> @@ -66,7 +66,7 @@ <ul> <li><a href="http://jira.qos.ch/secure/IssueNavigator.jspa">Search for - cai18n bugs</a></li> </ul> + cal10n bugs</a></li> </ul> <h2>Reporting with bugs</h2> @@ -82,7 +82,7 @@ <ul> <li><a href="http://jira.qos.ch/secure/CreateIssue!default.jspa">Report - new cai18n bug</a></li> + new cal10n bug</a></li> </ul> <script src="templates/footer.js" type="text/javascript"></script> diff --git a/cai18n-site/src/site/pages/css/_print.css b/cal10n-site/src/site/pages/css/_print.css similarity index 100% rename from cai18n-site/src/site/pages/css/_print.css rename to cal10n-site/src/site/pages/css/_print.css diff --git a/cai18n-site/src/site/pages/css/common.css b/cal10n-site/src/site/pages/css/common.css similarity index 100% rename from cai18n-site/src/site/pages/css/common.css rename to cal10n-site/src/site/pages/css/common.css diff --git a/cai18n-site/src/site/pages/css/prettify.css b/cal10n-site/src/site/pages/css/prettify.css similarity index 100% rename from cai18n-site/src/site/pages/css/prettify.css rename to cal10n-site/src/site/pages/css/prettify.css diff --git a/cai18n-site/src/site/pages/css/screen.css b/cal10n-site/src/site/pages/css/screen.css similarity index 100% rename from cai18n-site/src/site/pages/css/screen.css rename to cal10n-site/src/site/pages/css/screen.css diff --git a/cai18n-site/src/site/pages/documentation.html b/cal10n-site/src/site/pages/documentation.html similarity index 100% rename from cai18n-site/src/site/pages/documentation.html rename to cal10n-site/src/site/pages/documentation.html diff --git a/cai18n-site/src/site/pages/download.html b/cal10n-site/src/site/pages/download.html similarity index 77% rename from cai18n-site/src/site/pages/download.html rename to cal10n-site/src/site/pages/download.html index 35a5a7b..66197b8 100644 --- a/cai18n-site/src/site/pages/download.html +++ b/cal10n-site/src/site/pages/download.html @@ -22,19 +22,19 @@ <h2>Download links</h2> - <p>CAI18N modules are available as downloads including full source + <p>CAL10N modules are available as downloads including full source code, class files and documentation. </p> <ul> <li><a - href="dist/cai18n-${pom.version}.zip">cai18n-${pom.version}.zip</a></li> - <li><a href="dist/cai18n-${project.version}.tar.gz">cai18n-${pom.version}.tar.gz</a></li> + href="dist/cal10n-${pom.version}.zip">cal10n-${pom.version}.zip</a></li> + <li><a href="dist/cal10n-${project.version}.tar.gz">cal10n-${pom.version}.tar.gz</a></li> </ul> - <p>If you wish to download an older version of cai18n, please - refer to the <a href="http://cai18n.qos.ch/dist/">distributions + <p>If you wish to download an older version of cal10n, please + refer to the <a href="http://cal10n.qos.ch/dist/">distributions directory</a>.</p> diff --git a/cai18n-site/src/site/pages/index.html b/cal10n-site/src/site/pages/index.html similarity index 72% rename from cai18n-site/src/site/pages/index.html rename to cal10n-site/src/site/pages/index.html index 94318e8..b14e7b6 100644 --- a/cai18n-site/src/site/pages/index.html +++ b/cal10n-site/src/site/pages/index.html @@ -20,14 +20,15 @@ <div id="content"> - <h1>Compiler Assisted Internationalization (CAI18N)</h1> + <h1>Compiler Assisted Localization (CAL10N)</h1> - <p>Compiler Assisted Internationalization, abbreviated as CAI18N, - is a java library for writing internationalized messages. + <p>Compiler Assisted Localization, abbreviated as CAL10N + (pronounced as "callon") is a java library for writing localized + (internationalized) messages. </p> - <p>Before you start using CAI18N, we highly recommend that you read - the two-page <a href="manual.html">CAI18N user manual</a>. + <p>Before you start using CAL10N, we highly recommend that you read + the two-page <a href="manual.html">CAL10N user manual</a>. </p> <script src="templates/footer.js" type="text/javascript"></script> diff --git a/cai18n-site/src/site/pages/js/prettify.js b/cal10n-site/src/site/pages/js/prettify.js similarity index 100% rename from cai18n-site/src/site/pages/js/prettify.js rename to cal10n-site/src/site/pages/js/prettify.js diff --git a/cai18n-site/src/site/pages/license.html b/cal10n-site/src/site/pages/license.html similarity index 94% rename from cai18n-site/src/site/pages/license.html rename to cal10n-site/src/site/pages/license.html index 220470e..2fed136 100644 --- a/cai18n-site/src/site/pages/license.html +++ b/cal10n-site/src/site/pages/license.html @@ -19,9 +19,9 @@ </div> <div id="content"> - <h1>Licensing terms for CAI18N</h1> + <h1>Licensing terms for CAL10N</h1> - <p>CAI18N software, including source code and binaries are + <p>CAL10N software, including source code and binaries are distributed under the MIT license. </p> diff --git a/cai18n-site/src/site/pages/mailinglist.html b/cal10n-site/src/site/pages/mailinglist.html similarity index 75% rename from cai18n-site/src/site/pages/mailinglist.html rename to cal10n-site/src/site/pages/mailinglist.html index 7fa3d54..deaf4ea 100644 --- a/cai18n-site/src/site/pages/mailinglist.html +++ b/cal10n-site/src/site/pages/mailinglist.html @@ -62,97 +62,97 @@ <th>Archives</th> </tr> <tr class="b"> - <td>Cai18n Announce List</td> + <td>Cal10n Announce List</td> <td>Low</td> <td> <a - href="http://qos.ch/mailman/listinfo/cai18n-announce"> + href="http://qos.ch/mailman/listinfo/cal10n-announce"> Subscribe </a> </td> <td> <a - href="http://qos.ch/mailman/options/cai18n-announce"> + href="http://qos.ch/mailman/options/cal10n-announce"> Unsubscribe </a> </td> <td> <a - href="http://www.qos.ch/pipermail/cai18n-announce/"> + href="http://www.qos.ch/pipermail/cal10n-announce/"> pipermail </a>  </td> </tr> <tr class="a"> - <td>Cai18n User List</td> + <td>Cal10n User List</td> <td>Medium</td> <td> <a - href="http://qos.ch/mailman/listinfo/cai18n-user"> + href="http://qos.ch/mailman/listinfo/cal10n-user"> Subscribe </a> </td> <td> <a - href="http://qos.ch/mailman/options/cai18n-user"> + href="http://qos.ch/mailman/options/cal10n-user"> Unsubscribe </a> </td> <td> <a - href="http://www.qos.ch/pipermail/cai18n-user/"> + href="http://www.qos.ch/pipermail/cal10n-user/"> pipermail </a>  </td> </tr> <tr class="b"> - <td>Cai18n Dev List</td> + <td>Cal10n Dev List</td> <td>Medium</td> <td> <a - href="http://qos.ch/mailman/listinfo/cai18n-dev"> + href="http://qos.ch/mailman/listinfo/cal10n-dev"> Subscribe </a> </td> <td> <a - href="http://qos.ch/mailman/options/cai18n-dev"> + href="http://qos.ch/mailman/options/cal10n-dev"> Unsubscribe </a> </td> <td> <a - href="http://www.qos.ch/pipermail/cai18n-dev/"> + href="http://www.qos.ch/pipermail/cal10n-dev/"> pipermail </a>  diff --git a/cai18n-site/src/site/pages/manual.html b/cal10n-site/src/site/pages/manual.html similarity index 81% rename from cai18n-site/src/site/pages/manual.html rename to cal10n-site/src/site/pages/manual.html index d917761..cc916c5 100644 --- a/cai18n-site/src/site/pages/manual.html +++ b/cal10n-site/src/site/pages/manual.html @@ -56,9 +56,9 @@ </tr> </table> - <h1>CAI18N Manual</h1> + <h1>CAL10N Manual</h1> - <p>The goal of CAI18N project is to enhance the existing + <p>The goal of CAL10N project is to enhance the existing internationalization functionality offered by the Java platform with consistency and verification primitives. It is assumed that you are already somewhat familiar with <a @@ -68,7 +68,7 @@ <h3>Acknowledgment</h3> - <p>The original idea behind CAI18N is attributed to Takeshi Kondo. It + <p>The original idea behind CAL10N is attributed to Takeshi Kondo. It consolidated into what it is today subsequent to a <a href="http://markmail.org/thread/drcabfc6z42sijdo">discussion</a> involving Ralph Goers, Ceki Gülcü, Takeshi Kondo and Pete @@ -79,17 +79,17 @@ <h3>Core idea</h3> <p>Instead of using values of type String as the key for each - message, CAI18N uses <code>enums</code>.</p> + message, CAL10N uses <code>enums</code>.</p> <p>For example, let us assume that you wanted to internationalize - color names. In CAI18N you could start by writing an enum type, + color names. In CAL10N you could start by writing an enum type, named Colors. You can choose any name for the enum type. Colors is just the name this particular author picked.</p> <pre class="prettyprint source">package com.foo.somePackage; -import ch.qos.cai18n.LocaleNames; -import ch.qos.cai18n.ResourceBundleName; +import ch.qos.cal10n.LocaleNames; +import ch.qos.cal10n.ResourceBundleName; @ResourceBundleName("colors") // mandatory annotation @LocaleNames({"en_UK", "fr"}) // list of locale names used by @@ -130,7 +130,7 @@ GREEN=les {0} sont verts</pre> <p>In your application, you would retrieve the localized message via an <a - href="apidocs/ch/qos/cai18n/IMessageConveyor.html">IMessageConveyor</a> + href="apidocs/ch/qos/cal10n/IMessageConveyor.html">IMessageConveyor</a> instance. </p> <pre class="prettyprint source">// obtain a message conveyor for France @@ -140,13 +140,13 @@ IMessageConveyor mc = new MessageConveyor(Locale.FRANCE); String red = mc.getMessage(Colors.RED); String blue = mc.getMessage(Colors.BLUE); </pre> - <p>CAI18N leverages the existing resource bundle infrastructure you + <p>CAL10N leverages the existing resource bundle infrastructure you have been accustomed to, but adds compiler verification on top.</p> <p>An astute reader will comment that even if the messages codes are now verified by the compiler, it is still possible to have mismatching - message codes in the resources bundles. For this reason, CAI18N + message codes in the resources bundles. For this reason, CAL10N comes with additional tooling support. </p> @@ -169,17 +169,17 @@ import java.util.Locale; import org.junit.Test; -import ch.qos.cai18n.verifier.Cai18nError; -import ch.qos.cai18n.verifier.IMessageCodeVerifier; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.Cal10nError; +import ch.qos.cal10n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; public class MyColorVerificationTest { @Test public void en_UK() { IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = mcv.verify(Locale.UK); - for(Cai18nError error: errorList) { + List<Cal10nError> errorList = mcv.verify(Locale.UK); + for(Cal10nError error: errorList) { System.out.println(error); } assertEquals(0, errorList.size()); @@ -188,8 +188,8 @@ public class MyColorVerificationTest { @Test public void fr() { IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = mcv.verify(Locale.FRANCE); - for(Cai18nError error: errorList) { + List<Cal10nError> errorList = mcv.verify(Locale.FRANCE); + for(Cal10nError error: errorList) { System.out.println(error); } assertEquals(0, errorList.size()); @@ -215,10 +215,10 @@ public class MyColorVerificationTest { <code>AssertionError</code>. </p> - <pre class="source">Code [BLUE] present in enum type [ch.qos.cai18n.sample.Colors] but absent in resource bundle \ + <pre class="source">Code [BLUE] present in enum type [ch.qos.cal10n.sample.Colors] but absent in resource bundle \ named [colors] for locale [fr_FR] Code [BLEU] present in resource bundle named [colors] for locale [fr_FR] but absent \ - in enum type [ch.qos.cai18n.sample.Colors]</pre> + in enum type [ch.qos.cal10n.sample.Colors]</pre> <h3>One test to rule them all</h3> @@ -236,9 +236,9 @@ import java.util.Locale; import org.junit.Test; -import ch.qos.cai18n.verifier.Cai18nError; -import ch.qos.cai18n.verifier.IMessageCodeVerifier; -import ch.qos.cai18n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.Cal10nError; +import ch.qos.cal10n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageCodeVerifier; public class MyAllInOneColorVerificationTest { @@ -246,8 +246,8 @@ public class MyAllInOneColorVerificationTest { @Test public void all() { IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cai18nError> errorList = mcv.verifyAllLocales(); - for(Cai18nError error: errorList) { + List<Cal10nError> errorList = mcv.verifyAllLocales(); + for(Cal10nError error: errorList) { System.out.println(error); } assertEquals(0, errorList.size()); @@ -257,21 +257,21 @@ public class MyAllInOneColorVerificationTest { <h2>Maven Plugin</h2> - <p>The CAI18N project ships with a maven plugin designed to verify + <p>The CAL10N project ships with a maven plugin designed to verify that the keys specified in a given enum type match those found in the corresponding resource bundles and for each locale. Our plugin - is unsurprisingly called <em>mvn-cai18n-plugin</em>. + is unsurprisingly called <em>mvn-cal10n-plugin</em>. </p> <p><b>Until the relevant artifacts are uploaded to the central maven repository, you unfortunately need to install the - <em>maven-cai18n-plugin</em> manually by running "mvn install" from - the folder where you unpacked the CAI18N distribution.</b> + <em>maven-cal10n-plugin</em> manually by running "mvn install" from + the folder where you unpacked the CAL10N distribution.</b> </p> - <p>Using <em>maven-cai18n-plugin</em> is pretty easy. To verify + <p>Using <em>maven-cal10n-plugin</em> is pretty easy. To verify enums in a given project, just declare the - <em>maven-cai18n-plugin</em> in the <code><build></code> section, + <em>maven-cal10n-plugin</em> in the <code><build></code> section, enumerating all the enum types you would like to see checked.</p> <p>Here is a sample <em>pom.xml</em> snippet.</p> @@ -280,8 +280,8 @@ public class MyAllInOneColorVerificationTest { <plugins> ... other plugins <plugin> - <groupId>ch.qos.cai18n.plugins</groupId> - <artifactId>maven-cai18n-plugin</artifactId> + <groupId>ch.qos.cal10n.plugins</groupId> + <artifactId>maven-cal10n-plugin</artifactId> <version>${project.version}</version> <executions> <execution> @@ -304,7 +304,7 @@ public class MyAllInOneColorVerificationTest { </build> </pre> <p>After you add the above snippet to the pom.xml file of your - project, <em>maven-cai18n-plugin</em> will make sure that + project, <em>maven-cal10n-plugin</em> will make sure that your resource bundles and your enum type are in synchronized. </p> @@ -316,7 +316,7 @@ public class MyAllInOneColorVerificationTest { <h2>Eclipse plug-in</h2> <p>We are looking for volunteers willing to implement IDE support - for CAI18N. Below is a litst of possible features of this IDE which + for CAL10N. Below is a litst of possible features of this IDE which we think could have added value. </p> @@ -348,14 +348,14 @@ public class MyAllInOneColorVerificationTest { </ul> - <p>If interested please contact the cai18n-dev mailing list.</p> + <p>If interested please contact the cal10n-dev mailing list.</p> <h2>Ant task</h2> <p>We are looking for volunteers to implement an Ant task to verify resource bundles. The Ant task could be modeled after the - <em>maven-cai18n-plugin</em> altough the Ant plugin is likely to be - simpler. If interested please contact the cai18n-dev mailing + <em>maven-cal10n-plugin</em> altough the Ant plugin is likely to be + simpler. If interested please contact the cal10n-dev mailing list.</p> <script src="templates/footer.js" type="text/javascript"></script> diff --git a/cai18n-site/src/site/pages/news.html b/cal10n-site/src/site/pages/news.html similarity index 81% rename from cai18n-site/src/site/pages/news.html rename to cal10n-site/src/site/pages/news.html index 7f2ecd7..f66f94c 100644 --- a/cai18n-site/src/site/pages/news.html +++ b/cal10n-site/src/site/pages/news.html @@ -20,15 +20,21 @@ </div> <div id="content"> - <h2>CAI18N News</h2> + <h2>CAL10N News</h2> - <p>You can receive cai18n-related announcements by subscribing to + <p>You can receive cal10n-related announcements by subscribing to the <a - href="http://www.qos.ch/mailman/listinfo/cai18n-announce">cai18n-announce</a> + href="http://www.qos.ch/mailman/listinfo/cal10n-announce">cal10n-announce</a> mailing list.</p> <hr width="80%" align="center" /> + <h3>28th of August 2009 - Release of CAL10N version 0.4</h3> + + + <p>Project has been renamed as CAL10N, pronounced "callon". The + former name CAI18N was hard to pronounce.</p> + <h3>28th of August 2009 - Release of CAI18N version 0.3</h3> <p>Same code, improved documentation.</p> diff --git a/cai18n-site/src/site/pages/repos.html b/cal10n-site/src/site/pages/repos.html similarity index 79% rename from cai18n-site/src/site/pages/repos.html rename to cal10n-site/src/site/pages/repos.html index 4587049..fae5c0f 100644 --- a/cai18n-site/src/site/pages/repos.html +++ b/cal10n-site/src/site/pages/repos.html @@ -46,16 +46,16 @@ <tr> <td>on github</td> <td> - <a href="http://github.com/ceki/cai18n/tree/master"> - http://github.com/ceki/cai18n/tree/master</a> (slow but rich) + <a href="http://github.com/ceki/cal10n/tree/master"> + http://github.com/ceki/cal10n/tree/master</a> (slow but rich) </td> </tr> <tr> <td>on git.qos.ch</td> - <td><a href="http://git.qos.ch/gitweb/?p=cai18n.git;a=summary"> - http://git.qos.ch/gitweb/?p=cai18n.git;a=summary</a> (fast but minimal) + <td><a href="http://git.qos.ch/gitweb/?p=cal10n.git;a=summary"> + http://git.qos.ch/gitweb/?p=cal10n.git;a=summary</a> (fast but minimal) </td> </tr> </table> @@ -63,8 +63,8 @@ <h2>Cloning</h2> - <p>Anyone can clone cai18n's source repository. All you need is a - git client. To clone cai18n's git repository, issue one of the + <p>Anyone can clone cal10n's source repository. All you need is a + git client. To clone cal10n's git repository, issue one of the two following commands: </p> <table cellpadding="4" cellspacing="1" class="bodyTable" style="font-size: 120%;"> @@ -76,17 +76,17 @@ <tr > <td>git</td> - <td><code>git clone git://git.qos.ch/cai18n</code></td> + <td><code>git clone git://git.qos.ch/cal10n</code></td> </tr> <tr class="alt"> <td>git</td> - <td><code>git clone git://github.com/ceki/cai18n.git</code></td> + <td><code>git clone git://github.com/ceki/cal10n.git</code></td> </tr> <tr > <td>http</td> - <td><code>git clone http://git.qos.ch/cai18n/</code></td> + <td><code>git clone http://git.qos.ch/cal10n/</code></td> </tr> </table> diff --git a/cai18n-site/src/site/pages/templates/creative.js b/cal10n-site/src/site/pages/templates/creative.js similarity index 100% rename from cai18n-site/src/site/pages/templates/creative.js rename to cal10n-site/src/site/pages/templates/creative.js diff --git a/cai18n-site/src/site/pages/templates/footer.js b/cal10n-site/src/site/pages/templates/footer.js similarity index 100% rename from cai18n-site/src/site/pages/templates/footer.js rename to cal10n-site/src/site/pages/templates/footer.js diff --git a/cai18n-site/src/site/pages/templates/header.js b/cal10n-site/src/site/pages/templates/header.js similarity index 100% rename from cai18n-site/src/site/pages/templates/header.js rename to cal10n-site/src/site/pages/templates/header.js diff --git a/cai18n-site/src/site/pages/templates/left.js b/cal10n-site/src/site/pages/templates/left.js similarity index 100% rename from cai18n-site/src/site/pages/templates/left.js rename to cal10n-site/src/site/pages/templates/left.js diff --git a/cai18n-site/src/site/pages/templates/right.js b/cal10n-site/src/site/pages/templates/right.js similarity index 100% rename from cai18n-site/src/site/pages/templates/right.js rename to cal10n-site/src/site/pages/templates/right.js diff --git a/cai18n-site/src/site/pages/templates/setup.js b/cal10n-site/src/site/pages/templates/setup.js similarity index 100% rename from cai18n-site/src/site/pages/templates/setup.js rename to cal10n-site/src/site/pages/templates/setup.js diff --git a/cai18n-site/src/site/resources/images/CAI18N_logo.ai b/cal10n-site/src/site/resources/images/CAI18N_logo.ai similarity index 100% rename from cai18n-site/src/site/resources/images/CAI18N_logo.ai rename to cal10n-site/src/site/resources/images/CAI18N_logo.ai diff --git a/cai18n-site/src/site/resources/images/CAI18N_logo.gif b/cal10n-site/src/site/resources/images/CAI18N_logo.gif similarity index 100% rename from cai18n-site/src/site/resources/images/CAI18N_logo.gif rename to cal10n-site/src/site/resources/images/CAI18N_logo.gif diff --git a/maven-cai18n-plugin-smoke/pom.xml b/maven-cal10n-plugin-smoke/pom.xml similarity index 59% rename from maven-cai18n-plugin-smoke/pom.xml rename to maven-cal10n-plugin-smoke/pom.xml index 3d6cfac..57f5872 100644 --- a/maven-cai18n-plugin-smoke/pom.xml +++ b/maven-cal10n-plugin-smoke/pom.xml @@ -2,30 +2,30 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <parent> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-parent</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-parent</artifactId> <version>0.3</version> </parent> <modelVersion>4.0.0</modelVersion> - <groupId>ch.qos.cai18n</groupId> - <artifactId>maven-cai18n-plugin-smoke</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>maven-cal10n-plugin-smoke</artifactId> <packaging>jar</packaging> - <name>Compiler assisted internationalization library (CAI18N) - Maven Testing</name> + <name>Compiler assisted localization library (CAL10N) - Maven Testing</name> <dependencies> <dependency> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-api</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-api</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> - <groupId>ch.qos.cai18n.plugins</groupId> - <artifactId>maven-cai18n-plugin</artifactId> + <groupId>ch.qos.cal10n.plugins</groupId> + <artifactId>maven-cal10n-plugin</artifactId> <version>${project.version}</version> <executions> <execution> @@ -36,7 +36,7 @@ </goals> <configuration> <enumTypes> - <enumType>ch.qos.cai18n.smoke.Countries</enumType> + <enumType>ch.qos.cal10n.smoke.Countries</enumType> </enumTypes> </configuration> </execution> diff --git a/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java b/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java similarity index 50% rename from maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java rename to maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java index 48f97a1..51e31fe 100644 --- a/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java +++ b/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java @@ -1,7 +1,7 @@ -package ch.qos.cai18n.smoke; +package ch.qos.cal10n.smoke; -import ch.qos.cai18n.LocaleNames; -import ch.qos.cai18n.ResourceBundleName; +import ch.qos.cal10n.LocaleNames; +import ch.qos.cal10n.ResourceBundleName; @ResourceBundleName("countries") @LocaleNames({"en", "fr"}) diff --git a/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/package.html b/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/package.html similarity index 100% rename from maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/package.html rename to maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/package.html diff --git a/maven-cai18n-plugin-smoke/src/main/resources/countries_en.properties b/maven-cal10n-plugin-smoke/src/main/resources/countries_en.properties similarity index 100% rename from maven-cai18n-plugin-smoke/src/main/resources/countries_en.properties rename to maven-cal10n-plugin-smoke/src/main/resources/countries_en.properties diff --git a/maven-cai18n-plugin-smoke/src/main/resources/countries_fr.properties b/maven-cal10n-plugin-smoke/src/main/resources/countries_fr.properties similarity index 100% rename from maven-cai18n-plugin-smoke/src/main/resources/countries_fr.properties rename to maven-cal10n-plugin-smoke/src/main/resources/countries_fr.properties diff --git a/maven-cai18n-plugin/pom.xml b/maven-cal10n-plugin/pom.xml similarity index 81% rename from maven-cai18n-plugin/pom.xml rename to maven-cal10n-plugin/pom.xml index 7bfbd12..17d3cb3 100644 --- a/maven-cai18n-plugin/pom.xml +++ b/maven-cal10n-plugin/pom.xml @@ -6,18 +6,18 @@ <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>cai18n-parent</artifactId> - <groupId>ch.qos.cai18n</groupId> + <artifactId>cal10n-parent</artifactId> + <groupId>ch.qos.cal10n</groupId> <version>0.3</version> </parent> - <groupId>ch.qos.cai18n.plugins</groupId> - <artifactId>maven-cai18n-plugin</artifactId> + <groupId>ch.qos.cal10n.plugins</groupId> + <artifactId>maven-cal10n-plugin</artifactId> <packaging>maven-plugin</packaging> - <name> Compiler assisted internationalization library (CAI18N) - Maven</name> - <url>http://cai18n.qos.ch</url> + <name> Compiler assisted localization library (CAL10N) - Maven</name> + <url>http://cal10n.qos.ch</url> <dependencies> <dependency> @@ -33,8 +33,8 @@ </dependency> <dependency> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-api</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-api</artifactId> </dependency> <dependency> diff --git a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/ThisFirstClassLoader.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java similarity index 93% rename from maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/ThisFirstClassLoader.java rename to maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java index 12cf782..85dfabc 100644 --- a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/ThisFirstClassLoader.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.plugins; +package ch.qos.cal10n.plugins; import java.net.URL; import java.net.URLClassLoader; @@ -59,7 +59,7 @@ public class ThisFirstClassLoader extends URLClassLoader { // Treating IMessageCodeVerifier as a special case is the whole point of the // exercise. - if (name.equals("ch.qos.cai18n.verifier.IMessageCodeVerifier")) { + if (name.equals("ch.qos.cal10n.verifier.IMessageCodeVerifier")) { return super.loadClass(name, resolve); } diff --git a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/VerifyMojo.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java similarity index 91% rename from maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/VerifyMojo.java rename to maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java index 9a76142..2575157 100644 --- a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/VerifyMojo.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java @@ -19,7 +19,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.plugins; +package ch.qos.cal10n.plugins; import java.io.File; import java.lang.reflect.Constructor; @@ -37,8 +37,8 @@ import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; -import ch.qos.cai18n.Cai18nConstants; -import ch.qos.cai18n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.Cal10nConstants; +import ch.qos.cal10n.verifier.IMessageCodeVerifier; /** * Verifies resources bundles in various locales against an enumType @@ -49,9 +49,9 @@ import ch.qos.cai18n.verifier.IMessageCodeVerifier; */ public class VerifyMojo extends AbstractMojo { - final static String MISSING_LOCALE = Cai18nConstants.CODE_URL_PREFIX + final static String MISSING_LOCALE = Cal10nConstants.CODE_URL_PREFIX + "#missingLocale"; - final static String MISSING_ENUM_TYPES = Cai18nConstants.CODE_URL_PREFIX + final static String MISSING_ENUM_TYPES = Cal10nConstants.CODE_URL_PREFIX + "#missingEnumType"; /** @@ -145,8 +145,7 @@ public class VerifyMojo extends AbstractMojo { try { URLClassLoader cl = (URLClassLoader) buildClassLoader(); - Class<?> cla = Class.forName( - "ch.qos.cai18n.verifier.MessageCodeVerifier", true, cl); + Class<?> cla = Class.forName(Cal10nConstants.MessageCodeVerifier_FQCN, true, cl); Constructor<?> cons = cla.getConstructor(String.class); diff --git a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/package.html b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/package.html similarity index 100% rename from maven-cai18n-plugin/src/main/java/ch/qos/cai18n/plugins/package.html rename to maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/package.html diff --git a/pom.xml b/pom.xml index 6068ef0..93c0ea8 100644 --- a/pom.xml +++ b/pom.xml @@ -3,13 +3,13 @@ <modelVersion>4.0.0</modelVersion> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-parent</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-parent</artifactId> <packaging>pom</packaging> <version>0.3</version> - <name>Compiler assisted internationalization library (CAI18N) - Parent</name> + <name>Compiler assisted localization library (CAL10N) - Parent</name> - <url>http://cai18n.qos.ch</url> + <url>http://cal10n.qos.ch</url> <organization> <name>QOS.ch</name> @@ -18,10 +18,10 @@ <inceptionYear>2009</inceptionYear> <modules> - <module>cai18n-api</module> - <module>cai18n-site</module> - <module>maven-cai18n-plugin</module> - <module>maven-cai18n-plugin-smoke</module> + <module>cal10n-api</module> + <module>cal10n-site</module> + <module>maven-cal10n-plugin</module> + <module>maven-cal10n-plugin-smoke</module> </modules> <licenses> @@ -55,8 +55,8 @@ </dependency> <dependency> - <groupId>ch.qos.cai18n</groupId> - <artifactId>cai18n-api</artifactId> + <groupId>ch.qos.cal10n</groupId> + <artifactId>cal10n-api</artifactId> <version>${project.version}</version> </dependency> </dependencies> @@ -118,7 +118,7 @@ </descriptor> </descriptors> <finalName> - cai18n-${project.version} + cal10n-${project.version} </finalName> <appendAssemblyId>false</appendAssemblyId> <outputDirectory>target/site/dist/</outputDirectory> @@ -170,13 +170,13 @@ </links> <groups> <group> - <title>CAI18N API packages</title> - <packages>ch.qos.cai18n:ch.qos.cai18n.verifier:ch.qos.cai18n.util</packages> + <title>CAL10N API packages</title> + <packages>ch.qos.cal10n:ch.qos.cal10n.verifier:ch.qos.cal10n.util</packages> </group> <group> - <title>CAI18N Maven plugin</title> - <packages>ch.qos.cai18n.plugins</packages> + <title>CAL10N Maven plugin</title> + <packages>ch.qos.cal10n.plugins</packages> </group> </groups> @@ -191,7 +191,7 @@ <distributionManagement> <site> <id>pixie</id> - <url>scp://pixie/var/www/cai18n.qos.ch/htdocs/</url> + <url>scp://pixie/var/www/cal10n.qos.ch/htdocs/</url> </site> <repository> diff --git a/src/main/assembly/dist.xml b/src/main/assembly/dist.xml index aaf0065..fd77704 100644 --- a/src/main/assembly/dist.xml +++ b/src/main/assembly/dist.xml @@ -7,8 +7,8 @@ <fileSets>  <fileSet> - <directory>cai18n-api/</directory> - <outputDirectory>cai18n-api/</outputDirectory> + <directory>cal10n-api/</directory> + <outputDirectory>cal10n-api/</outputDirectory> <includes> <include> pom.xml @@ -20,8 +20,8 @@ </fileSet> <fileSet> - <directory>cai18n-site/</directory> - <outputDirectory>cai18n-site/</outputDirectory> + <directory>cal10n-site/</directory> + <outputDirectory>cal10n-site/</outputDirectory> <includes> <include> pom.xml @@ -33,8 +33,8 @@ </fileSet> <fileSet> - <directory>maven-cai18n-plugin/</directory> - <outputDirectory>maven-cai18n-plugin</outputDirectory> + <directory>maven-cal10n-plugin/</directory> + <outputDirectory>maven-cal10n-plugin</outputDirectory> <includes> <include> pom.xml @@ -46,8 +46,8 @@ </fileSet> <fileSet> - <directory>maven-cai18n-plugin-smoke</directory> - <outputDirectory>maven-cai18n-plugin-smoke</outputDirectory> + <directory>maven-cal10n-plugin-smoke</directory> + <outputDirectory>maven-cal10n-plugin-smoke</outputDirectory> <includes> <include> pom.xml @@ -60,8 +60,8 @@  <fileSet> - <directory>cai18n-api/src/</directory> - <outputDirectory>cai18n-api/src/</outputDirectory> + <directory>cal10n-api/src/</directory> + <outputDirectory>cal10n-api/src/</outputDirectory> <excludes> <exclude> test/output/ @@ -70,34 +70,34 @@ </fileSet> <fileSet> - <directory>cai18n-site/src/</directory> - <outputDirectory>cai18n-site/src/</outputDirectory> + <directory>cal10n-site/src/</directory> + <outputDirectory>cal10n-site/src/</outputDirectory> </fileSet> <fileSet> - <directory>maven-cai18n-plugin/src/</directory> - <outputDirectory>maven-cai18n-plugin/src/</outputDirectory> + <directory>maven-cal10n-plugin/src/</directory> + <outputDirectory>maven-cal10n-plugin/src/</outputDirectory> </fileSet> <fileSet> - <directory>maven-cai18n-plugin-smoke/src/</directory> - <outputDirectory>maven-cai18n-plugin-smoke/src/</outputDirectory> + <directory>maven-cal10n-plugin-smoke/src/</directory> + <outputDirectory>maven-cal10n-plugin-smoke/src/</outputDirectory> </fileSet>  <fileSet> - <directory>cai18n-api/target/</directory> + <directory>cal10n-api/target/</directory> <outputDirectory>/</outputDirectory> <includes> - <include>cai18n-api-${project.version}.jar</include> + <include>cal10n-api-${project.version}.jar</include> </includes> </fileSet>  <fileSet> - <directory>cai18n-api/target/</directory> + <directory>cal10n-api/target/</directory> <outputDirectory>/</outputDirectory> <includes> - <include>cai18n-api-${project.version}-sources.jar</include> + <include>cal10n-api-${project.version}-sources.jar</include> </includes> </fileSet> http://git.qos.ch/gitweb/?p=cai18n.git;a=commit;h=757d2b84c9d3f73608cbfed15… http://github.com/ceki/cai18n/commit/757d2b84c9d3f73608cbfed156ac8b74538bde… commit 757d2b84c9d3f73608cbfed156ac8b74538bde82 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Aug 28 19:16:02 2009 +0200 better docs diff --git a/cai18n-site/src/site/pages/manual.html b/cai18n-site/src/site/pages/manual.html index e882817..d917761 100644 --- a/cai18n-site/src/site/pages/manual.html +++ b/cai18n-site/src/site/pages/manual.html @@ -22,6 +22,39 @@ <div id="content"> + <table style="margin-left: 0em; padding-top:0ex" cellpadding="0" + cellspacing="0" width="70%"> + <tr> + <td> + <p class="author"> + Author: Ceki Gülcü + <br/> + Copyright © 2009, QOS.ch</p> + </td> + <td> + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-sa/2.5/"> + <img alt="Creative Commons License" + style="border-width: 0; margin-left: 1em" + src="http://creativecommons.org/images/public/somerights20.png" /> + </a> + </td> + </tr> + <tr> + <td> + <p> + This document is licensed under a + <a rel="license" + href="http://creativecommons.org/licenses/by-nc-sa/2.5/"> + Creative Commons + Attribution-NonCommercial-ShareAlike 2.5 + License + </a> + </p> + </td> + <td></td> + </tr> + </table> <h1>CAI18N Manual</h1> @@ -45,11 +78,13 @@ <h3>Core idea</h3> - <p>Instead of using values of type String as the key each message, - CAI18N uses <code>enums</code>.</p> + <p>Instead of using values of type String as the key for each + message, CAI18N uses <code>enums</code>.</p> - <p>For the sake of argument, assume you wish to internationalize - color names, in CAI18N you could write a color enum.</p> + <p>For example, let us assume that you wanted to internationalize + color names. In CAI18N you could start by writing an enum type, + named Colors. You can choose any name for the enum type. Colors is + just the name this particular author picked.</p> <pre class="prettyprint source">package com.foo.somePackage; @@ -66,12 +101,14 @@ public enum Colors { }</pre> - <p>Once you define a few color names, you can create a regular - resource bundle named after value of the @ResourceBundleName + <p>Once you define a few color codes, you can create a regular + resource bundle named after the value of the @ResourceBundleName annotation in Colors and the appropriate locale. For example, for the UK locale, you would name your resource bundle as <em>colors_en_UK.properties</em>. It should also be placed in the - root of folder of the appropriate jar file.</p> + appropriate folder on your class path or in the root folder of an + appropriate jar file. (It is assumed that you know how to work with + resource bundles.) </p> <p>Here is a sample a <em>colors_en_UK.properties</em> file:</p> @@ -81,7 +118,7 @@ RED=roses are red GREEN={0} are green </pre> <p>For the french locale, the resource bundle would be named - <em>colors_fr.properties</em>. Here are possible contents.</p> + <em>colors_fr.properties</em>. Here are sample contents.</p> <pre class="source"> BLUE=les violettes sont bleues @@ -91,11 +128,13 @@ GREEN=les {0} sont verts</pre> <h2>Retrieving internationalized messages</h2> - <p>In your application, you would retrieve the localized message as - follows: </p> + <p>In your application, you would retrieve the localized message via + an <a + href="apidocs/ch/qos/cai18n/IMessageConveyor.html">IMessageConveyor</a> + instance. </p> <pre class="prettyprint source">// obtain a message conveyor for France -MessageConveyor mc = new MessageConveyor(Locale.FRANCE); +IMessageConveyor mc = new MessageConveyor(Locale.FRANCE); // use it to retrieve internationalized messages String red = mc.getMessage(Colors.RED); ----------------------------------------------------------------------- Summary of changes: .../main/java/ch/qos/cai18n/Cai18nConstants.java | 15 -- {cai18n-api => cal10n-api}/LICENSE.txt | 0 {cai18n-api => cal10n-api}/pom.xml | 8 +- .../main/java/ch/qos/cal10n/Cal10nConstants.java | 16 +++ .../main/java/ch/qos/cal10n}/IMessageConveyor.java | 2 +- .../src/main/java/ch/qos/cal10n}/LocaleNames.java | 4 +- .../main/java/ch/qos/cal10n}/MessageConveyor.java | 6 +- .../java/ch/qos/cal10n}/ResourceBundleName.java | 4 +- .../src/main/java/ch/qos/cal10n}/package.html | 2 +- .../ch/qos/cal10n}/util/AnnotationExtractor.java | 6 +- .../src/main/java/ch/qos/cal10n}/util/package.html | 2 +- .../java/ch/qos/cal10n/verifier/Cal10nError.java | 6 +- .../java/ch/qos/cal10n}/verifier/ErrorFactory.java | 10 +- .../qos/cal10n}/verifier/IMessageCodeVerifier.java | 6 +- .../qos/cal10n}/verifier/MessageCodeVerifier.java | 32 +++--- .../main/java/ch/qos/cal10n}/verifier/package.html | 0 .../src/test/java/ch/qos/cal10n/AllCal10nTest.java | 8 +- .../test/java/ch/qos/cal10n}/sample/Colors.java | 6 +- .../test/java/ch/qos/cal10n}/sample/Countries.java | 6 +- .../cal10n}/sample/MessageCodeVerifierTest.java | 14 +- .../ch/qos/cal10n}/sample/MessageConveyorTest.java | 4 +- .../sample/MyAllInOneColorVerificationTest.java | 10 +- .../cal10n}/sample/MyColorVerificationTest.java | 16 +- .../java/ch/qos/cal10n}/sample/PackageTest.java | 2 +- .../qos/cal10n}/util/AnnotationExtractorTest.java | 4 +- .../src/test/java/ch/qos/cal10n}/util/Fruit.java | 6 +- .../test/java/ch/qos/cal10n}/util/PackageTest.java | 2 +- .../src/test/resources/colors_en.properties | 0 .../src/test/resources/colors_fr.properties | 0 .../src/test/resources/countries_en.properties | 0 .../src/test/resources/countries_fr.properties | 0 {cai18n-site => cal10n-site}/LICENSE.txt | 0 {cai18n-site => cal10n-site}/pom.xml | 10 +- .../src/site/pages/bugreport.html | 8 +- .../src/site/pages/css/_print.css | 0 .../src/site/pages/css/common.css | 0 .../src/site/pages/css/prettify.css | 0 .../src/site/pages/css/screen.css | 0 .../src/site/pages/documentation.html | 4 +- .../src/site/pages/download.html | 10 +- .../src/site/pages/index.html | 13 +- .../src/site/pages/js/prettify.js | 0 .../src/site/pages/license.html | 6 +- .../src/site/pages/mailinglist.html | 36 +++--- .../src/site/pages/manual.html | 135 +++++++++++++------- .../src/site/pages/news.html | 12 ++- .../src/site/pages/repos.html | 18 ++-- .../src/site/pages/templates/creative.js | 0 .../src/site/pages/templates/footer.js | 0 .../src/site/pages/templates/header.js | 4 +- .../src/site/pages/templates/left.js | 2 +- .../src/site/pages/templates/right.js | 0 .../src/site/pages/templates/setup.js | 0 .../src/site/resources/images/CAI18N_logo.ai | 0 .../src/site/resources/images/CAI18N_logo.gif | Bin 7013 -> 7013 bytes .../pom.xml | 20 ++-- .../main/java/ch/qos/cal10n}/smoke/Countries.java | 6 +- .../main/java/ch/qos/cal10n}/smoke/package.html | 0 .../src/main/resources/countries_en.properties | 0 .../src/main/resources/countries_fr.properties | 0 .../pom.xml | 16 +- .../qos/cal10n}/plugins/ThisFirstClassLoader.java | 4 +- .../java/ch/qos/cal10n}/plugins/VerifyMojo.java | 13 +- .../main/java/ch/qos/cal10n}/plugins/package.html | 0 pom.xml | 32 +++--- src/main/assembly/dist.xml | 40 +++--- 66 files changed, 317 insertions(+), 269 deletions(-) delete mode 100644 cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java rename {cai18n-api => cal10n-api}/LICENSE.txt (100%) rename {cai18n-api => cal10n-api}/pom.xml (62%) create mode 100644 cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/IMessageConveyor.java (96%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/LocaleNames.java (94%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/MessageConveyor.java (92%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/ResourceBundleName.java (94%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/package.html (77%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/util/AnnotationExtractor.java (92%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/util/package.html (90%) rename cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java => cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java (93%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/verifier/ErrorFactory.java (83%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/verifier/IMessageCodeVerifier.java (89%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/verifier/MessageCodeVerifier.java (81%) rename {cai18n-api/src/main/java/ch/qos/cai18n => cal10n-api/src/main/java/ch/qos/cal10n}/verifier/package.html (100%) rename cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java => cal10n-api/src/test/java/ch/qos/cal10n/AllCal10nTest.java (87%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/Colors.java (90%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/Countries.java (90%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/MessageCodeVerifierTest.java (83%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/MessageConveyorTest.java (93%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/MyAllInOneColorVerificationTest.java (83%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/MyColorVerificationTest.java (79%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/sample/PackageTest.java (95%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/util/AnnotationExtractorTest.java (93%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/util/Fruit.java (90%) rename {cai18n-api/src/test/java/ch/qos/cai18n => cal10n-api/src/test/java/ch/qos/cal10n}/util/PackageTest.java (95%) rename {cai18n-api => cal10n-api}/src/test/resources/colors_en.properties (100%) rename {cai18n-api => cal10n-api}/src/test/resources/colors_fr.properties (100%) rename {cai18n-api => cal10n-api}/src/test/resources/countries_en.properties (100%) rename {cai18n-api => cal10n-api}/src/test/resources/countries_fr.properties (100%) rename {cai18n-site => cal10n-site}/LICENSE.txt (100%) rename {cai18n-site => cal10n-site}/pom.xml (80%) rename {cai18n-site => cal10n-site}/src/site/pages/bugreport.html (91%) rename {cai18n-site => cal10n-site}/src/site/pages/css/_print.css (100%) rename {cai18n-site => cal10n-site}/src/site/pages/css/common.css (100%) rename {cai18n-site => cal10n-site}/src/site/pages/css/prettify.css (100%) rename {cai18n-site => cal10n-site}/src/site/pages/css/screen.css (100%) rename {cai18n-site => cal10n-site}/src/site/pages/documentation.html (89%) rename {cai18n-site => cal10n-site}/src/site/pages/download.html (77%) rename {cai18n-site => cal10n-site}/src/site/pages/index.html (70%) rename {cai18n-site => cal10n-site}/src/site/pages/js/prettify.js (100%) rename {cai18n-site => cal10n-site}/src/site/pages/license.html (93%) rename {cai18n-site => cal10n-site}/src/site/pages/mailinglist.html (75%) rename {cai18n-site => cal10n-site}/src/site/pages/manual.html (67%) rename {cai18n-site => cal10n-site}/src/site/pages/news.html (81%) rename {cai18n-site => cal10n-site}/src/site/pages/repos.html (79%) rename {cai18n-site => cal10n-site}/src/site/pages/templates/creative.js (100%) rename {cai18n-site => cal10n-site}/src/site/pages/templates/footer.js (100%) rename {cai18n-site => cal10n-site}/src/site/pages/templates/header.js (59%) rename {cai18n-site => cal10n-site}/src/site/pages/templates/left.js (91%) rename {cai18n-site => cal10n-site}/src/site/pages/templates/right.js (100%) rename {cai18n-site => cal10n-site}/src/site/pages/templates/setup.js (100%) rename {cai18n-site => cal10n-site}/src/site/resources/images/CAI18N_logo.ai (100%) rename {cai18n-site => cal10n-site}/src/site/resources/images/CAI18N_logo.gif (100%) rename {maven-cai18n-plugin-smoke => maven-cal10n-plugin-smoke}/pom.xml (59%) rename {maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n => maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n}/smoke/Countries.java (50%) rename {maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n => maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n}/smoke/package.html (100%) rename {maven-cai18n-plugin-smoke => maven-cal10n-plugin-smoke}/src/main/resources/countries_en.properties (100%) rename {maven-cai18n-plugin-smoke => maven-cal10n-plugin-smoke}/src/main/resources/countries_fr.properties (100%) rename {maven-cai18n-plugin => maven-cal10n-plugin}/pom.xml (81%) rename {maven-cai18n-plugin/src/main/java/ch/qos/cai18n => maven-cal10n-plugin/src/main/java/ch/qos/cal10n}/plugins/ThisFirstClassLoader.java (93%) rename {maven-cai18n-plugin/src/main/java/ch/qos/cai18n => maven-cal10n-plugin/src/main/java/ch/qos/cal10n}/plugins/VerifyMojo.java (91%) rename {maven-cai18n-plugin/src/main/java/ch/qos/cai18n => maven-cal10n-plugin/src/main/java/ch/qos/cal10n}/plugins/package.html (100%) hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] Type safe message definition
by Takeshi Kondo 28 Aug '09

28 Aug '09

Hi Ceki I have two type safe message definition idea. I've committed draft code to my cai18n project clone. (http://github.com/takeshi/cai18n/tree/master) Please take it in cai18n project, if you like it,. My ideas is as follows. 1. Message definition by annotation for instance, public enum LocalizedColors { @Message("green") GREEN { @Message("vert") Locale fr = Locale.FRANCE; @Message("midori") Locale ja = Locale.JAPAN; } } Using enum field declaration with annotation, we can define localized message. It is simple , but we can't add other locale. 2. Message definition by switch case for instance, public class ColorDef_fr extends MessageDefinition<Colors> { public Locale getLocale() { return Locale.FRANCE; } public String getMessage(Colors e) { switch (e) { case BLUE: return "blue"; case GREEN: return "vert"; case RED: return "rouge"; } return null; } } Using method return, we can define localized message. It is not simple, but this we can define it per locale.

3 11

[cai18n-dev] [GIT] Compiler assisted internalization library annotated tag, v0.3, created. v0.3
by git-noreply＠pixie.qos.ch 28 Aug '09

28 Aug '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted internalization library". The annotated tag, v0.3 has been created at 98d12120aae5f8021798602e10faaa0fd0d1620d (tag) tagging 4e73aefc83f9f6c2462c18fb49e24d588bafbde5 (commit) replaces v0.1 tagged by Ceki Gulcu on Fri Aug 28 18:10:43 2009 +0200 - Log ----------------------------------------------------------------- adding tag 0.3 Ceki Gulcu (5): - attribute original idea to Takeshi Kondo minor doc improvements - same code better docs - entry relating to release 0.3 - fix typo (hey the unit test work!) ----------------------------------------------------------------------- hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. v0.1-5-g4e73aef
by git-noreply＠pixie.qos.ch 28 Aug '09

28 Aug '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted internalization library". The branch, master has been updated via 4e73aefc83f9f6c2462c18fb49e24d588bafbde5 (commit) from 7c173a44f1aa6fd04b31afa895a616c6cf34745e (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cai18n.git;a=commit;h=4e73aefc83f9f6c2462c18fb4… http://github.com/ceki/cai18n/commit/4e73aefc83f9f6c2462c18fb49e24d588bafbd… commit 4e73aefc83f9f6c2462c18fb49e24d588bafbde5 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Fri Aug 28 18:07:15 2009 +0200 - fix typo (hey the unit test work!) diff --git a/cai18n-api/src/test/resources/colors_fr.properties b/cai18n-api/src/test/resources/colors_fr.properties index 93c28bb..0ea9e8c 100644 --- a/cai18n-api/src/test/resources/colors_fr.properties +++ b/cai18n-api/src/test/resources/colors_fr.properties @@ -1,3 +1,3 @@ -BLEU=les violettes sont bleues +BLUE=les violettes sont bleues RED=les roses sont rouges GREEN=les {0} sont verts \ No newline at end of file ----------------------------------------------------------------------- Summary of changes: cai18n-api/src/test/resources/colors_fr.properties | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) hooks/post-receive -- Compiler assisted internalization library

1 0