senselogic.sitevision.api.metadata.builder

Interface LinkValueBuilder

All Superinterfaces:

Builder<LinkValue>

@Requireable(value="LinkValueBuilder")
public interface LinkValueBuilder
extends Builder<LinkValue>

Builder to create LinkValue instances that can be used to set link metadata.

LinkValueBuilder has one mandatory attribute:

• target - The link target. Must be non-null.

LinkValueBuilder also has some optional attributes:

• name - The link name. Default is null.
• description - The Link description. Default is null.
• open in new window - Whether or not the link should be opened in new window. Default is false.

Using the LinkValueBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the LinkValueBuilder
2. Set the target
3. Possibly set a name
4. Possibly set a description
5. Possibly set open in new window
6. Do build

When you have built a LinkValue instance, you can re-use the LinkValueBuilder to build more instances. Something like:

1. Set a new target
2. Possibly set a name
3. Possibly set a description
4. Possibly set open in new window
5. Do build

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via MetadataUtil.getLinkValueBuilder(). See MetadataUtil for how to obtain an instance of the MetadataUtil interface.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
LinkValue	build() Creates a LinkValue instance using current state of this builder.
LinkValueBuilder	setDescription(String aDescription) Sets the link description.
LinkValueBuilder	setExternalTarget(String aURL) Sets the target.
LinkValueBuilder	setInternalTarget(Node aNode) Sets the target.
LinkValueBuilder	setMailTarget(String aMailAddress) Sets the target.
LinkValueBuilder	setName(String aName) Sets the link name.
LinkValueBuilder	setOpenInNewWindow(boolean aOpenInNewWindow) Sets open in new window.
LinkValueBuilder	setPhoneTarget(String aPhoneNumber) Sets the target.

Method Detail

setExternalTarget

LinkValueBuilder setExternalTarget(String aURL)
                            throws IllegalArgumentException

Sets the target.

Parameters:

aURL - the link target URL

Returns:

this builder

Throws:

IllegalArgumentException - if aURL is null or whitespace only

setMailTarget

LinkValueBuilder setMailTarget(String aMailAddress)
                        throws IllegalArgumentException

Sets the target.

Parameters:

aMailAddress - a mail address

Returns:

this builder

Throws:

IllegalArgumentException - if aMailAddress is null, whitespace only or an invalid mail address.

See Also:

MailUtil.isValidAddress(String)

setPhoneTarget

LinkValueBuilder setPhoneTarget(String aPhoneNumber)
                         throws IllegalArgumentException

Sets the target.

Parameters:

aPhoneNumber - a phone number

Returns:

this builder

Throws:

IllegalArgumentException - if aPhoneNumber is null, whitespace only or an invalid phone number.

Since:

Sitevision 4.2.1

setInternalTarget

LinkValueBuilder setInternalTarget(Node aNode)
                            throws IllegalArgumentException

Sets the target.

Parameters:

aNode - the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.

Returns:

this builder

Throws:

IllegalArgumentException - if aNode is null or not a linkable resource.

setName

LinkValueBuilder setName(String aName)

Sets the link name.

Parameters:

aName - the link name

Returns:

this builder

setDescription

LinkValueBuilder setDescription(String aDescription)

Sets the link description.

Parameters:

aDescription - the link description

Returns:

this builder

setOpenInNewWindow

LinkValueBuilder setOpenInNewWindow(boolean aOpenInNewWindow)

Sets open in new window.

Parameters:

aOpenInNewWindow - whether or not the link should be opened in new window

Returns:

this builder

build

LinkValue build()
         throws IllegalStateException

Creates a LinkValue instance using current state of this builder.

Specified by:

build in interface Builder<LinkValue>

Returns:

a link value

Throws:

IllegalStateException - if there are no link target.