Groovydoc.Link (Groovy Documentation)

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.tasks.javadoc
[Java] Class Groovydoc.Link

java.lang.Object
  org.gradle.api.tasks.javadoc.Groovydoc.Link

public static class Groovydoc.Link

A Link class represent a link between groovydoc/javadoc output and url.

Constructor Summary
`Groovydoc.Link(java.lang.String url, java.lang.String packages)` Constructs a `Link`.

Method Summary
`boolean`	`equals(java.lang.Object o)`
`java.util.List`	`getPackages()` Returns a list of package prefixes to be linked with an external site.
`java.lang.String`	`getUrl()` Returns the base url for the external site.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Constructor Detail

public Groovydoc.Link(java.lang.String url, java.lang.String packages)

Constructs a Link.

Parameters:: url - Base URL of external site; packages - list of package prefixes

Method Detail

@Override
public boolean equals(java.lang.Object o)

public java.util.List getPackages()

Returns a list of package prefixes to be linked with an external site.

public java.lang.String getUrl()

Returns the base url for the external site.

@Override
public int hashCode()

Groovy Documentation