li.cil.tis3d.api.serial

Class SerialProtocolDocumentationReference

java.lang.Object

li.cil.tis3d.api.serial.SerialProtocolDocumentationReference

public final class SerialProtocolDocumentationReference
extends java.lang.Object

Represents a reference to a manual page describing a protocol used by a SerialInterface.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	link The path to the manual page describing the protocol.
java.lang.String	name The name of the reference, i.e.

Constructor Summary

Constructors

Constructor and Description
SerialProtocolDocumentationReference(java.lang.String name, java.lang.String link)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

The name of the reference, i.e. the text of the link in the manual.

Note that this is run through I18n, so it is generally a good idea to use localizable values here.

link

public final java.lang.String link

The path to the manual page describing the protocol.

Constructor Detail

SerialProtocolDocumentationReference

public SerialProtocolDocumentationReference(java.lang.String name,
                                            java.lang.String link)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object