org.xwiki.rendering.internal.macro.jira.displayer.field.KeyJIRAFieldDisplayer.java Source code

Introduction

Here is the source code for org.xwiki.rendering.internal.macro.jira.displayer.field.KeyJIRAFieldDisplayer.java

Source

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.internal.macro.jira.displayer.field;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import javax.inject.Named;
import javax.inject.Singleton;

import org.jdom2.Element;
import org.xwiki.component.annotation.Component;
import org.xwiki.rendering.block.Block;
import org.xwiki.rendering.block.FormatBlock;
import org.xwiki.rendering.block.LinkBlock;
import org.xwiki.rendering.block.VerbatimBlock;
import org.xwiki.rendering.listener.Format;
import org.xwiki.rendering.listener.reference.ResourceReference;
import org.xwiki.rendering.listener.reference.ResourceType;
import org.xwiki.rendering.macro.jira.JIRAFieldDisplayer;
import org.xwiki.rendering.macro.jira.JIRAFields;

/**
 * Displayer for the "key" JIRA field (displayed with an external link to the JIRA issue).
 *
 * @version $Id: 7ebef6b5026460feb38cbe290b5d982c780626f3 $
 * @since 4.2M1
 */
@Component
@Named("key")
@Singleton
public class KeyJIRAFieldDisplayer implements JIRAFieldDisplayer {
    @Override
    public List<Block> displayField(String fieldName, Element issue) {
        List<Block> result = Collections.emptyList();
        String key = issue.getChildText(JIRAFields.KEY);
        if (key != null) {
            String link = issue.getChildText(JIRAFields.LINK);
            List<Block> labelBlocks = Arrays.<Block>asList(new VerbatimBlock(key, true));

            // If the Issue is closed then display it striked-out
            String resolutionId = issue.getChild(JIRAFields.RESOLUTION).getAttributeValue("id");
            if (!"-1".equals(resolutionId)) {
                // The issue is resolved
                labelBlocks = Arrays.<Block>asList(new FormatBlock(labelBlocks, Format.STRIKEDOUT));
            }

            if (link != null) {
                ResourceReference reference = new ResourceReference(link, ResourceType.URL);
                result = Arrays.<Block>asList(new LinkBlock(labelBlocks, reference, true));
            } else {
                result = labelBlocks;
            }
        }
        return result;
    }
}