Author: painter
Date: Mon Nov 5 16:09:12 2018
New Revision: 1845822
URL: http://svn.apache.org/viewvc?rev=1845822&view=rev
Log:
Fix/update javadoc for fulcrum-mimetype
Modified:
turbine/fulcrum/trunk/mimetype/src/java/org/apache/fulcrum/mimetype/DefaultMimeTypeService.java
turbine/fulcrum/trunk/mimetype/src/test/org/apache/fulcrum/mimetype/util/MimeTypeMapperTest.java
Modified:
turbine/fulcrum/trunk/mimetype/src/java/org/apache/fulcrum/mimetype/DefaultMimeTypeService.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/mimetype/src/java/org/apache/fulcrum/mimetype/DefaultMimeTypeService.java?rev=1845822&r1=1845821&r2=1845822&view=diff
==============================================================================
---
turbine/fulcrum/trunk/mimetype/src/java/org/apache/fulcrum/mimetype/DefaultMimeTypeService.java
(original)
+++
turbine/fulcrum/trunk/mimetype/src/java/org/apache/fulcrum/mimetype/DefaultMimeTypeService.java
Mon Nov 5 16:09:12 2018
@@ -33,298 +33,280 @@ import org.apache.avalon.framework.logge
import org.apache.fulcrum.mimetype.util.CharSetMap;
import org.apache.fulcrum.mimetype.util.MimeType;
import org.apache.fulcrum.mimetype.util.MimeTypeMap;
+
/**
- * The MimeType Service maintains mappings between MIME types and
- * the corresponding file name extensions, and between locales and
- * character encodings.
+ * The MimeType Service maintains mappings between MIME types and the
+ * corresponding file name extensions, and between locales and character
+ * encodings.
*
- * <p>The MIME type mappings can be defined in MIME type files
- * located in user's home directory, Java home directory or
- * the current class jar. The default mapping file is defined
- * with the mime.type.file property. In addition, the service maintains
- * a set of most common mappings.
+ * <p>
+ * The MIME type mappings can be defined in MIME type files located in user's
+ * home directory, Java home directory or the current class jar. The default
+ * mapping file is defined with the mime.type.file property. In addition, the
+ * service maintains a set of most common mappings.
*
- * <p>The charset mappings can be defined in property files
- * located in user's home directory, Java home directory or
- * the current class jar. The default mapping file is defined
- * with the charset.file property. In addition, the service maintains
- * a set of most common mappings.
+ * <p>
+ * The charset mappings can be defined in property files located in user's home
+ * directory, Java home directory or the current class jar. The default mapping
+ * file is defined with the charset.file property. In addition, the service
+ * maintains a set of most common mappings.
+ *
+ * avalon.component name="mimetype" lifestyle="singleton" avalon.service
+ * type="org.apache.fulcrum.mimetype.MimeTypeService"
*
* @author <a href="mailto:ilkka.pr...@simsoft.fi";>Ilkka Priha</a>
* @author <a href="mailto:mcconn...@apache.org";>Stephen McConnell</a>
* @version $Id$
- *
- * @avalon.component name="mimetype" lifestyle="singleton"
- * @avalon.service type="org.apache.fulcrum.mimetype.MimeTypeService"
*/
-public class DefaultMimeTypeService
- extends AbstractLogEnabled
- implements MimeTypeService, Configurable, Initializable, Contextualizable
-{
- private String applicationRoot;
- /**
- * The MIME type file property.
- */
- public static final String MIME_TYPES = "mimetypes";
- /**
- * The charset file property.
- */
- public static final String CHARSETS = "charsets";
- // path to a mimetypes-file_extension mapping file
- private String mimetypePath;
- // path to a charset-language mapping file
- private String charsetPath;
- /**
- * The MIME type map used by the service.
- */
- private MimeTypeMap mimeTypeMap;
- /**
- * The charset map used by the service.
- */
- private CharSetMap charSetMap;
-
- /**
- * Constructs a new service.
- */
- public DefaultMimeTypeService()
- {
- // empty
- }
- /**
- * Sets a MIME content type mapping to extensions to the map.
- * The extension is specified by a MIME type name followed
- * by a list of file name extensions separated by a whitespace.
- *
- * @param spec a MIME type extension specification to add.
- */
- public void setContentType(String spec)
- {
- mimeTypeMap.setContentType(spec);
- }
- /**
- * Gets the MIME content type for a file as a string.
- *
- * @param file The file to look up a MIME type mapping for.
- * @return the MIME type string.
- */
- public String getContentType(File file)
- {
- return mimeTypeMap.getContentType(file);
- }
- /**
- * Gets the MIME content type for a named file as a string.
- *
- * @param fileName The name of the file to look up a MIME type
- * mapping for.
- * @return the MIME type string.
- */
- public String getContentType(String fileName)
- {
- return mimeTypeMap.getContentType(fileName);
- }
- /**
- * Gets the MIME content type for a file name extension as a string.
- *
- * @param fileName The name of the file to look up a MIME type
- * mapping for.
- * @param def The default MIME type to use if no mapping exists.
- * @return the MIME type string.
- */
- public String getContentType(String fileName, String def)
- {
- return mimeTypeMap.getContentType(fileName, def);
- }
- /**
- * Gets the MIME content type for a file.
- *
- * @param file the file.
- * @return the MIME type.
- */
- public MimeType getMimeContentType(File file)
- {
- return mimeTypeMap.getMimeContentType(file);
- }
- /**
- * Gets the MIME content type for a named file.
- *
- * @param name the name of the file.
- * @return the MIME type.
- */
- public MimeType getMimeContentType(String name)
- {
- return mimeTypeMap.getMimeContentType(name);
- }
- /**
- * Gets the MIME content type for a file name extension.
- *
- * @param ext the file name extension.
- * @param def the default type if none is found.
- * @return the MIME type.
- */
- public MimeType getMimeContentType(String ext, String def)
- {
- return mimeTypeMap.getMimeContentType(ext, def);
- }
- /**
- * Gets the default file name extension for a MIME type.
- * Note that the mappers are called in the reverse order.
- *
- * @param type the MIME type as a string.
- * @return the file name extension or null.
- */
- public String getDefaultExtension(String type)
- {
- return mimeTypeMap.getDefaultExtension(type);
- }
- /**
- * Gets the default file name extension for a MIME type.
- * Note that the mappers are called in the reverse order.
- *
- * @param mime the MIME type.
- * @return the file name extension or null.
- */
- public String getDefaultExtension(MimeType mime)
- {
- return mimeTypeMap.getDefaultExtension(mime);
- }
- /**
- * Sets a locale-charset mapping.
- *
- * @param key the key for the charset.
- * @param charset the corresponding charset.
- */
- public void setCharSet(String key, String charset)
- {
- charSetMap.setCharSet(key, charset);
- }
- /**
- * Gets the charset for a locale. First a locale specific charset
- * is searched for, then a country specific one and lastly a language
- * specific one. If none is found, the default charset is returned.
- *
- * @param locale the locale.
- * @return the charset.
- */
- public String getCharSet(Locale locale)
- {
- return charSetMap.getCharSet(locale);
- }
- /**
- * Gets the charset for a locale with a variant. The search
- * is performed in the following order:
- * "lang"_"country"_"variant"="charset",
- * _"counry"_"variant"="charset",
- * "lang"__"variant"="charset",
- * __"variant"="charset",
- * "lang"_"country"="charset",
- * _"country"="charset",
- * "lang"="charset".
- * If nothing of the above is found, the default charset is returned.
- *
- * @param locale the locale.
- * @param variant a variant field.
- * @return the charset.
- */
- public String getCharSet(Locale locale, String variant)
- {
- return charSetMap.getCharSet(locale, variant);
- }
- /**
- * Gets the charset for a specified key.
- *
- * @param key the key for the charset.
- * @return the found charset or the default one.
- */
- public String getCharSet(String key)
- {
- return charSetMap.getCharSet(key);
- }
- /**
- * Gets the charset for a specified key.
- *
- * @param key the key for the charset.
- * @param def the default charset if none is found.
- * @return the found charset or the given default.
- */
- public String getCharSet(String key, String def)
- {
- return charSetMap.getCharSet(key, def);
- }
-
- private String getRealPath(String path)
- {
- String absolutePath = null;
- if (applicationRoot == null)
- {
- absolutePath = new File(path).getAbsolutePath();
- }
- else
- {
- absolutePath = new File(applicationRoot, path).getAbsolutePath();
- }
- return absolutePath;
- }
- // ---------------- Avalon Lifecycle Methods ---------------------
- /**
- * Avalon component lifecycle method
- */
- public void configure(Configuration conf)
- {
- mimetypePath = conf.getAttribute(MIME_TYPES, null);
- charsetPath = conf.getAttribute(CHARSETS, null);
- if (mimetypePath != null)
- {
- mimetypePath = getRealPath(mimetypePath);
- }
- if (charsetPath != null)
- {
- charsetPath = getRealPath(charsetPath);
- }
- }
- /**
- * Avalon component lifecycle method
- */
- public void initialize() throws Exception
- {
- if (mimetypePath != null)
- {
- try
- {
- mimeTypeMap = new MimeTypeMap(mimetypePath);
- }
- catch (IOException x)
- {
- throw new Exception(mimetypePath, x);
- }
- }
- else
- {
- mimeTypeMap = new MimeTypeMap();
- }
- if (charsetPath != null)
- {
- try
- {
- charSetMap = new CharSetMap(charsetPath);
- }
- catch (IOException x)
- {
- throw new Exception(charsetPath, x);
- }
- }
- else
- {
- charSetMap = new CharSetMap();
- }
- }
-
- /**
- * @see org.apache.avalon.framework.context.Contextualizable
- * @avalon.entry key="urn:avalon:home" type="java.io.File"
- */
- public void contextualize(Context context) throws ContextException
- {
- this.applicationRoot = context.get( "urn:avalon:home" ).toString();
- }
+public class DefaultMimeTypeService extends AbstractLogEnabled
+ implements MimeTypeService, Configurable, Initializable,
Contextualizable {
+ private String applicationRoot;
+
+ /**
+ * The MIME type file property.
+ */
+ public static final String MIME_TYPES = "mimetypes";
+
+ /**
+ * The charset file property.
+ */
+ public static final String CHARSETS = "charsets";
+
+ // path to a mimetypes-file_extension mapping file
+ private String mimetypePath;
+
+ // path to a charset-language mapping file
+ private String charsetPath;
+
+ /**
+ * The MIME type map used by the service.
+ */
+ private MimeTypeMap mimeTypeMap;
+
+ /**
+ * The charset map used by the service.
+ */
+ private CharSetMap charSetMap;
+
+ /**
+ * Constructs a new service.
+ */
+ public DefaultMimeTypeService() {
+ }
+
+ /**
+ * Sets a MIME content type mapping to extensions to the map. The
extension is
+ * specified by a MIME type name followed by a list of file name
extensions
+ * separated by a whitespace.
+ *
+ * @param spec a MIME type extension specification to add.
+ */
+ public void setContentType(String spec) {
+ mimeTypeMap.setContentType(spec);
+ }
+
+ /**
+ * Gets the MIME content type for a file as a string.
+ *
+ * @param file The file to look up a MIME type mapping for.
+ * @return the MIME type string.
+ */
+ public String getContentType(File file) {
+ return mimeTypeMap.getContentType(file);
+ }
+
+ /**
+ * Gets the MIME content type for a named file as a string.
+ *
+ * @param fileName The name of the file to look up a MIME type mapping
for.
+ * @return the MIME type string.
+ */
+ public String getContentType(String fileName) {
+ return mimeTypeMap.getContentType(fileName);
+ }
+
+ /**
+ * Gets the MIME content type for a file name extension as a string.
+ *
+ * @param fileName The name of the file to look up a MIME type mapping
for.
+ * @param def The default MIME type to use if no mapping exists.
+ * @return the MIME type string.
+ */
+ public String getContentType(String fileName, String def) {
+ return mimeTypeMap.getContentType(fileName, def);
+ }
+
+ /**
+ * Gets the MIME content type for a file.
+ *
+ * @param file the file.
+ * @return the MIME type.
+ */
+ public MimeType getMimeContentType(File file) {
+ return mimeTypeMap.getMimeContentType(file);
+ }
+
+ /**
+ * Gets the MIME content type for a named file.
+ *
+ * @param name the name of the file.
+ * @return the MIME type.
+ */
+ public MimeType getMimeContentType(String name) {
+ return mimeTypeMap.getMimeContentType(name);
+ }
+
+ /**
+ * Gets the MIME content type for a file name extension.
+ *
+ * @param ext the file name extension.
+ * @param def the default type if none is found.
+ * @return the MIME type.
+ */
+ public MimeType getMimeContentType(String ext, String def) {
+ return mimeTypeMap.getMimeContentType(ext, def);
+ }
+
+ /**
+ * Gets the default file name extension for a MIME type. Note that the
mappers
+ * are called in the reverse order.
+ *
+ * @param type the MIME type as a string.
+ * @return the file name extension or null.
+ */
+ public String getDefaultExtension(String type) {
+ return mimeTypeMap.getDefaultExtension(type);
+ }
+
+ /**
+ * Gets the default file name extension for a MIME type. Note that the
mappers
+ * are called in the reverse order.
+ *
+ * @param mime the MIME type.
+ * @return the file name extension or null.
+ */
+ public String getDefaultExtension(MimeType mime) {
+ return mimeTypeMap.getDefaultExtension(mime);
+ }
+
+ /**
+ * Sets a locale-charset mapping.
+ *
+ * @param key the key for the charset.
+ * @param charset the corresponding charset.
+ */
+ public void setCharSet(String key, String charset) {
+ charSetMap.setCharSet(key, charset);
+ }
+
+ /**
+ * Gets the charset for a locale. First a locale specific charset is
searched
+ * for, then a country specific one and lastly a language specific one.
If none
+ * is found, the default charset is returned.
+ *
+ * @param locale the locale.
+ * @return the charset.
+ */
+ public String getCharSet(Locale locale) {
+ return charSetMap.getCharSet(locale);
+ }
+
+ /**
+ * Gets the charset for a locale with a variant. The search is
performed in the
+ * following order: "lang"_"country"_"variant"="charset",
+ * _"counry"_"variant"="charset", "lang"__"variant"="charset",
+ * __"variant"="charset", "lang"_"country"="charset",
_"country"="charset",
+ * "lang"="charset". If nothing of the above is found, the default
charset is
+ * returned.
+ *
+ * @param locale the locale.
+ * @param variant a variant field.
+ * @return the charset.
+ */
+ public String getCharSet(Locale locale, String variant) {
+ return charSetMap.getCharSet(locale, variant);
+ }
+
+ /**
+ * Gets the charset for a specified key.
+ *
+ * @param key the key for the charset.
+ * @return the found charset or the default one.
+ */
+ public String getCharSet(String key) {
+ return charSetMap.getCharSet(key);
+ }
+
+ /**
+ * Gets the charset for a specified key.
+ *
+ * @param key the key for the charset.
+ * @param def the default charset if none is found.
+ * @return the found charset or the given default.
+ */
+ public String getCharSet(String key, String def) {
+ return charSetMap.getCharSet(key, def);
+ }
+
+ private String getRealPath(String path) {
+ String absolutePath = null;
+ if (applicationRoot == null) {
+ absolutePath = new File(path).getAbsolutePath();
+ } else {
+ absolutePath = new File(applicationRoot,
path).getAbsolutePath();
+ }
+ return absolutePath;
+ }
+
+ // ---------------- Avalon Lifecycle Methods ---------------------
+ /**
+ * Avalon component lifecycle method
+ */
+ public void configure(Configuration conf) {
+ mimetypePath = conf.getAttribute(MIME_TYPES, null);
+ charsetPath = conf.getAttribute(CHARSETS, null);
+ if (mimetypePath != null) {
+ mimetypePath = getRealPath(mimetypePath);
+ }
+ if (charsetPath != null) {
+ charsetPath = getRealPath(charsetPath);
+ }
+ }
+
+ /**
+ * Avalon component lifecycle method
+ */
+ public void initialize() throws Exception {
+ if (mimetypePath != null) {
+ try {
+ mimeTypeMap = new MimeTypeMap(mimetypePath);
+ } catch (IOException x) {
+ throw new Exception(mimetypePath, x);
+ }
+ } else {
+ mimeTypeMap = new MimeTypeMap();
+ }
+ if (charsetPath != null) {
+ try {
+ charSetMap = new CharSetMap(charsetPath);
+ } catch (IOException x) {
+ throw new Exception(charsetPath, x);
+ }
+ } else {
+ charSetMap = new CharSetMap();
+ }
+ }
+
+ /**
+ * avalon.entry key="urn:avalon:home" type="java.io.File"
+ *
+ * {@link
org.apache.avalon.framework.context.Contextualizable#contextualize(Context)}
+ *
+ * @param context the context to use
+ * @throws ContextException exception if context not found
+ */
+ public void contextualize(Context context) throws ContextException {
+ this.applicationRoot =
context.get("urn:avalon:home").toString();
+ }
}
Modified:
turbine/fulcrum/trunk/mimetype/src/test/org/apache/fulcrum/mimetype/util/MimeTypeMapperTest.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/mimetype/src/test/org/apache/fulcrum/mimetype/util/MimeTypeMapperTest.java?rev=1845822&r1=1845821&r2=1845822&view=diff
==============================================================================
---
turbine/fulcrum/trunk/mimetype/src/test/org/apache/fulcrum/mimetype/util/MimeTypeMapperTest.java
(original)
+++
turbine/fulcrum/trunk/mimetype/src/test/org/apache/fulcrum/mimetype/util/MimeTypeMapperTest.java
Mon Nov 5 16:09:12 2018
@@ -57,7 +57,7 @@ public class MimeTypeMapperTest extends
/**
* Constructor for MimeTypeMapperTest.
- * @param arg0
+ * @param arg0 default arguments
*/
public MimeTypeMapperTest(String arg0)
{
