to.etc.webapp.mailer

Class TextLinkInfo

java.lang.Object

to.etc.webapp.mailer.TextLinkInfo

@Immutable
public final class TextLinkInfo
extends Object

Defines a link "target" for a given generic link in text strings. Instances of this class will be registered using register() calls.

Author:

Frits Jalvingh Created on Oct 29, 2010

Method Summary

Modifier and Type	Method and Description
String	getFullUrl(String key) Get the full URL by replacing {id} with the specified key.
static TextLinkInfo	getInfo(IIdentifyable<?> instance) Locates an instance for a specific data bclass.
static TextLinkInfo	getInfo(String linkName) Get the link info for the specified link name.
String	getLinkname() The name of the link inside the text file (the "local name")
String	getRurl() The application-relative URL that this link should defer to.
Class<?>	getTargetClass() If this type of link is always used to show a given data class, then this can contain that class to make adding links easier.
static void	register(Class<? extends IIdentifyable<?>> dataclass, String rurl) Register a link that represents a given data class.
static void	register(Class<? extends IIdentifyable<?>> dataclass, String linkname, String rurl) Register an explicitly named link that represents a given data type.
static void	register(String linkname, String rurl) Register a link by name without data class.

Methods inherited from class java.lang.Object

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

Method Detail

getRurl

@Nonnull
public String getRurl()

The application-relative URL that this link should defer to. The link will contain a "{id}" at the location where the key needs to be stored.

getTargetClass

@Nullable
public Class<?> getTargetClass()

If this type of link is always used to show a given data class, then this can contain that class to make adding links easier. See LinkedText.link(to.etc.webapp.query.IIdentifyable).

getLinkname

@Nonnull
public String getLinkname()

The name of the link inside the text file (the "local name")

register

public static void register(@Nonnull
                            Class<? extends IIdentifyable<?>> dataclass,
                            @Nonnull
                            String rurl)

Register a link that represents a given data class.

Parameters:

dataclass -

clz -

paramName -

register

public static void register(@Nonnull
                            Class<? extends IIdentifyable<?>> dataclass,
                            @Nonnull
                            String linkname,
                            @Nonnull
                            String rurl)

Register an explicitly named link that represents a given data type.

Parameters:

dataclass -

linkname -

rurl -

register

public static void register(@Nonnull
                            String linkname,
                            @Nonnull
                            String rurl)

Register a link by name without data class.

Parameters:

linkname -

rurl -

getInfo

@Nullable
public static TextLinkInfo getInfo(String linkName)

Get the link info for the specified link name.

Parameters:

linkName -

Returns:

getInfo

@Nullable
public static TextLinkInfo getInfo(@Nullable
                                             IIdentifyable<?> instance)

Locates an instance for a specific data bclass. The "best" link info that is matched (meaning that matches the "lowest" subclass) will be returned. If no info is found then this returns null. A null instance is explicitly allowed and returns null.

Parameters:

instance -

Returns:

getFullUrl

@Nonnull
public String getFullUrl(@Nonnull
                                  String key)

Get the full URL by replacing {id} with the specified key.

Parameters:

key -

Returns: