Package hudson.plugins.doclinks

Class Document

java.lang.Object

hudson.plugins.doclinks.Document

All Implemented Interfaces:

Serializable

public class Document
extends Object
implements Serializable

Document Model.

Author:

Seiji Sogabe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Document(String title, String description, String directory, boolean recursive, String file, String id)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getDirectory()
String	getFile()
String	getId()
String	getTitle()
boolean	hasResources(hudson.maven.MavenModule module)
boolean	hasResources(AbstractItem project)
boolean	isRecursive()
void	publish(FilePath origin, FilePath dest, PrintStream logger)
void	setId(String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Document

@DataBoundConstructor
public Document(String title,
                String description,
                String directory,
                boolean recursive,
                String file,
                String id)

Method Detail

getTitle

public String getTitle()

getDirectory

public String getDirectory()

isRecursive

public boolean isRecursive()

Since:

1.4

getFile

public String getFile()

getDescription

public String getDescription()

getId

public String getId()

setId

public void setId(String id)

hasResources

public boolean hasResources(AbstractItem project)

hasResources

public boolean hasResources(hudson.maven.MavenModule module)

publish

public void publish(FilePath origin,
                    FilePath dest,
                    PrintStream logger)
             throws IOException,
                    InterruptedException

Throws:

IOException

InterruptedException