/**
* Copyright © 2006-2016 Web Cohesion (info@webcohesion.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.webcohesion.enunciate.modules.docs;
import com.webcohesion.enunciate.Enunciate;
import com.webcohesion.enunciate.artifacts.*;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
/**
* An artifact bundle the contains information about a download file.
*
* @author Ryan Heaton
*/
public class SpecifiedArtifact extends BaseArtifact implements ArtifactBundle {
private String name;
private String description;
private final FileArtifact file;
private boolean showLink;
public SpecifiedArtifact(String module, String id, File file) {
super(module, id);
this.file = new FileArtifact(module, id, file);
}
/**
* Exports this bundle to the specified file or directory.
*
* @param fileOrDirectory The file or directory to which to export this bundle.
* @param enunciate The enunciated utilities to use.
*/
public void exportTo(File fileOrDirectory, Enunciate enunciate) throws IOException {
this.file.exportTo(fileOrDirectory, enunciate);
}
/**
* There's only one bundled artifact: the download file.
*
* @return There's only one bundled artifact: the download file.
*/
public Collection<? extends Artifact> getArtifacts() {
return Arrays.asList(file);
}
/**
* The name of this bundle.
*
* @return The name of this bundle.
*/
public String getName() {
return name;
}
/**
* The size of this download bundle.
*
* @return The size of this download bundle.
*/
public long getSize() {
return this.file.getSize();
}
/**
* The name of this bundle.
*
* @param name The name of this bundle.
*/
public void setName(String name) {
this.name = name;
}
/**
* The description of this bundle.
*
* @return The description of this bundle.
*/
public String getDescription() {
return description;
}
/**
* The description of this bundle.
*
* @param description The description of this bundle.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* The modification date of the file.
*
* @return The modification date of the file.
*/
public Date getCreated() {
return new Date(this.file.getFile().lastModified());
}
public FileArtifact getFile() {
return file;
}
@Override
public boolean isPublic() {
return true;
}
public void setShowLink(boolean showLink) {
this.showLink = showLink;
}
public boolean isShowLink() {
return showLink;
}
}