/*
- * jSite - a tool for uploading websites into Freenet
- * Copyright (C) 2006 David Roden
+ * jSite - a tool for uploading websites into Freenet Copyright (C) 2006 David
+ * Roden
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package de.todesbaum.jsite.application;
/**
* Container for various file options.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
*/
public class FileOption {
/** The insert state. */
private boolean insert;
+ /** Whether to insert a redirect. */
+ private boolean insertRedirect;
+
/** The custom key. */
private String customKey;
+ /** The changed name. */
+ private String changedName;
+
/** The default MIME type. */
private final String defaultMimeType;
/**
* 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>.
- *
+ * {@link #isInsert()} and {@link #isInsertRedirect()} both return {@code
+ * true}.
+ *
* @return The custom key
*/
public String getCustomKey() {
/**
* Sets the custom key. The custom key is only used when {@link #isInsert()}
- * returns <code>true</code>.
- *
+ * and {@link #isInsertRedirect()} both return {@code true}.
+ *
* @param customKey
* The custom key
*/
public void setCustomKey(String customKey) {
if (customKey == null) {
- customKey = "";
+ this.customKey = "";
+ } else {
+ this.customKey = customKey;
}
- this.customKey = customKey;
}
/**
- * Returns whether the file should be inserted. If a file is not inserted, a
- * custom key has to be specified for it.
- *
+ * Returns whether the file should be inserted. If a file is not inserted
+ * and {@link #isInsertRedirect()} is also {@code false}, the file will not
+ * be inserted at all.
+ *
* @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.
- *
+ * Sets whether the file should be inserted. If a file is not inserted and
+ * {@link #isInsertRedirect()} is also {@code false}, the file will not be
+ * inserted at all.
+ *
* @param insert
* <code>true</code> if the file should be inserted,
* <code>false</code> otherwise
}
/**
+ * Returns whether a redirect to a different key should be inserted. This
+ * will only matter if {@link #isInsert()} returns {@code false}. The key
+ * that should be redirected to still needs to be specified via
+ * {@link #setCustomKey(String)}.
+ *
+ * @return {@code true} if a redirect should be inserted, {@code false}
+ * otherwise
+ */
+ public boolean isInsertRedirect() {
+ return insertRedirect;
+ }
+
+ /**
+ * Sets whether a redirect should be inserted. This will only matter if
+ * {@link #isInsert()} returns {@code false}, i.e. it has been
+ * {@link #setInsert(boolean)} to {@code false}. The key that should be
+ * redirected to still needs to be specified via
+ * {@link #setCustomKey(String)}.
+ *
+ * @param insertRedirect
+ * {@code true} if a redirect should be inserted, {@code false}
+ * otherwise
+ */
+ public void setInsertRedirect(boolean insertRedirect) {
+ this.insertRedirect = insertRedirect;
+ }
+
+ /**
+ * Returns whether this file has a changed name. Use
+ * {@link #getChangedName()} is this method returns {@code true}.
+ *
+ * @return {@code true} if this file has a changed name, {@code false}
+ * otherwise
+ */
+ public boolean hasChangedName() {
+ return (changedName != null) && (changedName.length() > 0);
+ }
+
+ /**
+ * Returns the changed name for this file. This method will return {@code
+ * null} or an empty {@link String} if this file should not be renamed.
+ *
+ * @return The changed name, or {@code null} if this file should not be
+ * renamed
+ */
+ public String getChangedName() {
+ return changedName;
+ }
+
+ /**
+ * Sets the changed name for this file. Setting the changed file to {@code
+ * null} or an empty {@link String} will disable renaming.
+ *
+ * @param changedName
+ * The new changed name for this file
+ */
+ public void setChangedName(String changedName) {
+ this.changedName = changedName;
+ }
+
+ /**
* 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
*/
public void setMimeType(String mimeType) {
if (mimeType == null) {
- mimeType = defaultMimeType;
+ this.mimeType = defaultMimeType;
+ } else {
+ this.mimeType = mimeType;
}
- this.mimeType = mimeType;
}
/**
* 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
*/
public void setContainer(String container) {
if (container == null) {
- container = DEFAULT_CONTAINER;
+ this.container = DEFAULT_CONTAINER;
+ } else {
+ this.container = container;
}
- this.container = 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
+ * <code>true</code> to replace tags, <code>false</code> not to
+ * replace
*/
public void setReplaceEdition(boolean replaceEdition) {
this.replaceEdition = replaceEdition;
}
/**
- * 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
+ * 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
*/
public boolean getReplaceEdition() {
return replaceEdition;
/**
* 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
*/
return false;
}
-}
\ No newline at end of file
+}
projects / jSite.git / blobdiff