Package io.micronaut.starter.feature.function

Class DocumentationLink

java.lang.Object

io.micronaut.starter.feature.function.DocumentationLink

@Introspected
public class DocumentationLink
extends Object

Encapsulates a link to Website.

Author:

Sergio del Amo

Constructor Summary

Constructors

Constructor	Description
DocumentationLink()
DocumentationLink(@NonNull String title, @NonNull String url)

Method Summary

Modifier and Type	Method	Description
@NonNull String	getTitle()	Gets the documentation title.
@NonNull String	getUrl()	Gets the documentation URL.
void	setTitle(@NonNull String title)	Sets the documentation title.
void	setUrl(@NonNull String url)	Sets the documentation URL.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentationLink

public DocumentationLink()

DocumentationLink

public DocumentationLink(@NonNull
 @NonNull String title,
 @NonNull
 @NonNull String url)

Method Details

getTitle

@NonNull
public @NonNull String getTitle()

Gets the documentation title. Subclasses may override to customize behavior.

Returns:

the documentation title

setTitle

public void setTitle(@NonNull
 @NonNull String title)

Sets the documentation title. Subclasses may override to customize behavior.

Parameters:

title - the documentation title to set

getUrl

@NonNull
public @NonNull String getUrl()

Gets the documentation URL. Subclasses may override to customize behavior.

Returns:

the documentation URL

setUrl

public void setUrl(@NonNull
 @NonNull String url)

Sets the documentation URL. Subclasses may override to customize behavior.

Parameters:

url - the documentation URL to set