Skip to content

Commit c193918

Browse files
author
John Keyes
committed
- tidied javadoc
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@267482 13f79535-47bb-0310-9956-ffa450edef68
1 parent 0a89be6 commit c193918

1 file changed

Lines changed: 17 additions & 43 deletions

File tree

src/java/org/apache/commons/cli2/resource/ResourceHelper.java

Lines changed: 17 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
/**
2-
* Copyright 2003-2004 The Apache Software Foundation
1+
/*
2+
* Copyright 2003-2005 The Apache Software Foundation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
2323

2424
/**
2525
* A utility class used to provide internationalisation support.
26+
*
2627
* @author John Keyes
2728
*/
2829
public class ResourceHelper {
@@ -53,8 +54,7 @@ public static ResourceHelper getResourceHelper(final Class clazz) {
5354
/**
5455
* Create a new ResourceHelper for the specified class.
5556
*
56-
* @param clazz
57-
* the Class that requires some resources
57+
* @param clazz the Class that requires some resources
5858
*/
5959
private ResourceHelper(final Class clazz) {
6060

@@ -83,44 +83,30 @@ private ResourceHelper(final Class clazz) {
8383
/**
8484
* Returns the message for the specified key.
8585
*
86-
* @param key
87-
* the unique identifier of the message
88-
*
86+
* @param key the unique identifier of the message
8987
* @return String the formatted String
9088
*/
9189
public String getMessage(final String key) {
92-
return getMessage(key, new Object[] {
93-
});
90+
return getMessage(key, new Object[] {});
9491
}
9592

9693
/**
9794
* Returns the message for the specified key and argument.
9895
*
99-
* @param key
100-
* the unique identifier of the message
101-
*
102-
* @param value
103-
* the argument value
104-
*
96+
* @param key the unique identifier of the message
97+
* @param value the argument value
10598
* @return String the formatted String
10699
*/
107100
public String getMessage(final String key, final Object value) {
108-
109101
return getMessage(key, new Object[] { value });
110102
}
111103

112104
/**
113105
* Returns the message for the specified key and arguments.
114106
*
115-
* @param key
116-
* the unique identifier of the message
117-
*
118-
* @param value1
119-
* an argument value
120-
*
121-
* @param value2
122-
* an argument value
123-
*
107+
* @param key the unique identifier of the message
108+
* @param value1 an argument value
109+
* @param value2 an argument value
124110
* @return String the formatted String
125111
*/
126112
public String getMessage(
@@ -134,17 +120,10 @@ public String getMessage(
134120
/**
135121
* Returns the message for the specified key and arguments.
136122
*
137-
* @param key
138-
* the unique identifier of the message
139-
*
140-
* @param value1
141-
* an argument value
142-
*
143-
* @param value2
144-
* an argument value
145-
*
146-
* @param value3
147-
* an argument value
123+
* @param key the unique identifier of the message
124+
* @param value1 an argument value
125+
* @param value2 an argument value
126+
* @param value3 an argument value
148127
*
149128
* @return String the formatted String
150129
*/
@@ -160,16 +139,11 @@ public String getMessage(
160139
/**
161140
* Returns the message for the specified key and arguments.
162141
*
163-
* @param key
164-
* the unique identifier of the message
165-
*
166-
* @param values
167-
* argument values
168-
*
142+
* @param key the unique identifier of the message
143+
* @param values argument values
169144
* @return String the formatted String
170145
*/
171146
public String getMessage(final String key, final Object[] values) {
172-
173147
final String msgFormatStr = bundle.getString(key);
174148
final MessageFormat msgFormat = new MessageFormat(msgFormatStr);
175149

0 commit comments

Comments
 (0)