org.daisy.common.xproc

Class XProcPortInfo

java.lang.Object

org.daisy.common.xproc.XProcPortInfo

public final class XProcPortInfo
extends Object

Info about an XProc port

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XProcPortInfo.Kind

Method Summary

Modifier and Type	Method and Description
XProcPortInfo.Kind	getKind() The kind of port.
String	getName() The port name.
boolean	isPrimary() Whether it is a primary port.
boolean	isRequired() Whether a connection is required on the port.
boolean	isSequence() Whether the port can accept/produce a sequence of documents.
static XProcPortInfo	newInputPort(String name, boolean isSequence, boolean isRequired, boolean isPrimary) Instantiates a new XProcPortInfo for an input port.
static XProcPortInfo	newOutputPort(String name, boolean isSequence, boolean isPrimary) Instantiates a new XProcPortInfo for an output port.
static XProcPortInfo	newParameterPort(String name, boolean isPrimary) Instantiates a new XProcPortInfo for a parameter input port.

Methods inherited from class java.lang.Object

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

Method Detail

newInputPort

public static XProcPortInfo newInputPort(String name,
                                         boolean isSequence,
                                         boolean isRequired,
                                         boolean isPrimary)

Instantiates a new XProcPortInfo for an input port.

newOutputPort

public static XProcPortInfo newOutputPort(String name,
                                          boolean isSequence,
                                          boolean isPrimary)

Instantiates a new XProcPortInfo for an output port.

newParameterPort

public static XProcPortInfo newParameterPort(String name,
                                             boolean isPrimary)

Instantiates a new XProcPortInfo for a parameter input port.

getKind

public XProcPortInfo.Kind getKind()

The kind of port.

getName

public String getName()

The port name.

isPrimary

public boolean isPrimary()

Whether it is a primary port.

isSequence

public boolean isSequence()

Whether the port can accept/produce a sequence of documents. A sequence of documents is always allowed on a parameter input port.

isRequired

public boolean isRequired()

Whether a connection is required on the port. A connection is required if the port does not have a default connection. Output ports never require a connection. Paramter input ports always required a connection.