cartago
Class Manual

java.lang.Object
  extended by cartago.Manual
All Implemented Interfaces:
java.io.Serializable

public class Manual
extends java.lang.Object
implements java.io.Serializable

This class represents the artifact manual, containing artifact operating instructions and function description.

Author:
aricci
See Also:
Serialized Form

Field Summary
static Manual EMPTY_MANUAL
           
 
Constructor Summary
Manual(java.lang.String manualName, java.net.URI uri)
           
 
Method Summary
 void addUsageProtocol(UsageProtocol p)
           
 java.lang.String getName()
           
 java.lang.String getSource()
           
 java.net.URI getURI()
           
 java.util.List<UsageProtocol> getUsageProtocols()
           
static Manual parse(java.io.File file)
           
static Manual parse(java.lang.String text)
           
 void setSource(java.lang.String src)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_MANUAL

public static final Manual EMPTY_MANUAL
Constructor Detail

Manual

public Manual(java.lang.String manualName,
              java.net.URI uri)
Method Detail

setSource

public void setSource(java.lang.String src)

addUsageProtocol

public void addUsageProtocol(UsageProtocol p)

getUsageProtocols

public java.util.List<UsageProtocol> getUsageProtocols()

getName

public java.lang.String getName()

getSource

public java.lang.String getSource()

getURI

public java.net.URI getURI()

parse

public static Manual parse(java.io.File file)
                    throws java.lang.Exception
Throws:
java.lang.Exception

parse

public static Manual parse(java.lang.String text)
                    throws java.lang.Exception
Throws:
java.lang.Exception


>DEIS - University of Bologna