/**
* Container for various file options.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
*/
public class FileOption {
/**
* Creates new file options.
- *
+ *
* @param defaultMimeType
* The default MIME type of the file
*/
/**
* Returns the custom key. The custom key is only used when
* {@link #isInsert()} returns <code>true</code>.
- *
+ *
* @return The custom key
*/
public String getCustomKey() {
/**
* Sets the custom key. The custom key is only used when {@link #isInsert()}
* returns <code>true</code>.
- *
+ *
* @param customKey
* The custom key
*/
/**
* Returns whether the file should be inserted. If a file is not inserted, a
* custom key has to be specified for it.
- *
+ *
* @see #setCustomKey(String)
* @return <code>true</code> if the file should be inserted,
* <code>false</code> otherwise
/**
* Sets whether the file should be inserted. If a file is not inserted, a
* custom key has to be specified for it.
- *
+ *
* @param insert
* <code>true</code> if the file should be inserted,
* <code>false</code> otherwise
/**
* Sets the MIME type of the file. Setting the MIME type to
* <code>null</code> will set the MIME type to the default MIME type.
- *
+ *
* @param mimeType
* The MIME type of the file
*/
/**
* Returns the MIME type of the file. If no custom MIME type has been set,
* the default MIME type is returned.
- *
+ *
* @return The MIME type of the file
*/
public String getMimeType() {
/**
* Returns the name of the container this file should be put in.
- *
+ *
* @return The name of the container
*/
public String getContainer() {
/**
* Sets the name of the container this file should be put in.
- *
+ *
* @param container
* The name of the container
*/
/**
* Sets whether the file should have “$[EDITION+<i>n</i>]” tags replaced.
- *
+ *
* @param replaceEdition
* <code>true</code> to replace tags, <code>false</code> not
* to replace
/**
* Returns whether the file should have “$[EDITION+<i>n</i>]” tags
* replaced.
- *
+ *
* @return <code>true</code> if tags should be replaced,
* <code>false</code> otherwise
*/
/**
* Sets the range of editions that should be replaced.
- *
+ *
* @param editionRange
* The range editions to replace
*/
/**
* Returns the range of editions that should be replaced.
- *
+ *
* @return The range of editions to replace
*/
public int getEditionRange() {
/**
* Returns whether the options for this file have been modified, i.e. are
* not at their default values.
- *
+ *
* @return <code>true</code> if the options have been modified,
* <code>false</code> if they are at default values
*/