com.phoenixnap.oss.ramlapisync.data

Class ApiDocumentMetadata

java.lang.Object

com.phoenixnap.oss.ramlapisync.data.ApiDocumentMetadata

public class ApiDocumentMetadata
extends Object

Class containing information about a document to be included in the generated raml file. Documents will be added as resources and must be bundled with the raml file

Since:

0.0.1

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
ApiDocumentMetadata(com.google.common.reflect.ClassPath.ResourceInfo document, String docSuffix)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDocumentPath() Gets the path to the document relative to the Raml file
String	getDocumentTitle()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocumentMetadata

public ApiDocumentMetadata(com.google.common.reflect.ClassPath.ResourceInfo document,
                           String docSuffix)

Parameters:

document - The resource pointing to the document to be represented

docSuffix - The portion of the filename that should be removed for Title generation

Method Detail

getDocumentPath

public String getDocumentPath()

Gets the path to the document relative to the Raml file

Returns:

The path

getDocumentTitle

public String getDocumentTitle()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object