io.wcm.handler.link.Link.java Source code

Introduction

Here is the source code for io.wcm.handler.link.Link.java

Source

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package io.wcm.handler.link;

import io.wcm.handler.commons.dom.Anchor;
import io.wcm.handler.link.spi.LinkType;
import io.wcm.handler.media.Asset;
import io.wcm.handler.media.Rendition;
import io.wcm.wcm.commons.util.ToStringStyle;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.jdom2.Attribute;
import org.osgi.annotation.versioning.ProviderType;

import com.day.cq.wcm.api.Page;

/**
 * Holds information about a link processed and resolved by {@link LinkHandler}.
 */
@ProviderType
public final class Link {

    private final LinkType linkType;
    private LinkRequest linkRequest;
    private boolean linkReferenceInvalid;
    private Anchor anchor;
    private String url;
    private Page targetPage;
    private Asset targetAsset;
    private Rendition targetRendition;

    /**
     * @param linkType Link type
     * @param linkRequest Processed link reference
     */
    public Link(LinkType linkType, LinkRequest linkRequest) {
        this.linkRequest = linkRequest;
        this.linkType = linkType;
    }

    /**
     * @return Link type
     */
    public LinkType getLinkType() {
        return this.linkType;
    }

    /**
     * @return Link request
     */
    public LinkRequest getLinkRequest() {
        return this.linkRequest;
    }

    /**
     * @param linkRequest Link request
     */
    public void setLinkRequest(LinkRequest linkRequest) {
        this.linkRequest = linkRequest;
    }

    /**
     * @return true if a link reference was set, but the reference was invalid and could not be resolved
     */
    public boolean isLinkReferenceInvalid() {
        return this.linkReferenceInvalid;
    }

    /**
     * @param linkReferenceInvalid true if a link reference was set, but the reference was invalid and could not be
     *          resolved
     */
    public void setLinkReferenceInvalid(boolean linkReferenceInvalid) {
        this.linkReferenceInvalid = linkReferenceInvalid;
    }

    /**
     * @return Anchor element
     */
    public Anchor getAnchor() {
        return this.anchor;
    }

    /**
     * @return Map with all attributes of the anchor element. Returns null if anchor element is null.
     */
    public Map<String, String> getAnchorAttributes() {
        if (getAnchor() == null) {
            return null;
        }
        Map<String, String> attributes = new HashMap<>();
        for (Attribute attribute : getAnchor().getAttributes()) {
            attributes.put(attribute.getName(), attribute.getValue());
        }
        return attributes;
    }

    /**
     * @param anchor Anchor element
     */
    public void setAnchor(Anchor anchor) {
        this.anchor = anchor;
    }

    /**
     * @return Link markup (only the opening anchor tag) or null if resolving was not successful.
     */
    public String getMarkup() {
        if (this.anchor != null) {
            return StringUtils.removeEnd(this.anchor.toString(), "</a>");
        } else {
            return null;
        }
    }

    /**
     * @return Link URL
     */
    public String getUrl() {
        return this.url;
    }

    /**
     * @param url Link URL
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * @return Target page referenced by the link (applies only for internal links)
     */
    public Page getTargetPage() {
        return this.targetPage;
    }

    /**
     * @param targetPage Target page referenced by the link (applies only for internal links)
     */
    public void setTargetPage(Page targetPage) {
        this.targetPage = targetPage;
    }

    /**
     * @return Target media item (applies only for media links)
     */
    public Asset getTargetAsset() {
        return this.targetAsset;
    }

    /**
     * @param targetAsset Target media item (applies only for media links)
     */
    public void setTargetAsset(Asset targetAsset) {
        this.targetAsset = targetAsset;
    }

    /**
     * @return Target media rendition (applies only for media links)
     */
    public Rendition getTargetRendition() {
        return this.targetRendition;
    }

    /**
     * @param targetRendition Target media rendition (applies only for media links)
     */
    public void setTargetRendition(Rendition targetRendition) {
        this.targetRendition = targetRendition;
    }

    /**
     * @return true if link is valid and was resolved successfully
     */
    public boolean isValid() {
        return getLinkType() != null && getUrl() != null && !StringUtils.equals(getUrl(), LinkHandler.INVALID_LINK);
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_OMIT_NULL_STYLE);
    }

}