org.ballerinalang.docgen.model

Class PackageName

java.lang.Object

org.ballerinalang.docgen.model.Caption

org.ballerinalang.docgen.model.PackageName

public class PackageName
extends Caption

Documentation model for representing a package name.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isPackageName
String	prefix
String	suffix

Fields inherited from class org.ballerinalang.docgen.model.Caption

value

Constructor Summary

Constructors

Constructor and Description
PackageName(String prefix, String suffix)

Method Summary

Modifier and Type	Method and Description
static List<Link>	convertList(List<String> packageNames) Converts a string list of package names to a Link list.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

isPackageName

public final boolean isPackageName

prefix

public final String prefix

suffix

public final String suffix

Constructor Detail

PackageName

public PackageName(String prefix,
                   String suffix)

Method Detail

convertList

public static List<Link> convertList(List<String> packageNames)

Converts a string list of package names to a Link list. While conversion, the PackageName's suffix and prefix is populated. The common part of all packages will set as prefix and the rest be as suffix.

Parameters:

packageNames - The package names.

Returns:

Package names as a link.

toString

public String toString()

Overrides:

toString in class Object