com.github.jgility.core.requirement.ImplementableStory.java Source code

Introduction

Here is the source code for com.github.jgility.core.requirement.ImplementableStory.java

Source

/*
 * 
 * Copyright (c) 2011 by Jgility Development Group
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Karsten Schulz
 *
 */
package com.github.jgility.core.requirement;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import com.github.jgility.core.project.Team;

/**
 * Konkrete Klasse fr {@link IImplementableRequirement}. Erbt Methoden von {@link ProductStory}
 * 
 * @author Karsten Schulz <lennylinux.ks@googlemail.com>
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class ImplementableStory extends ProductStory implements IImplementableRequirement {

    private ImplementState implementState;

    private Team team;

    /**
     * Instanziiert ein Objekt der Klasse {@link ImplementableStory} und erstellt auf Basis von
     * {@link ProductStory#ProductStory()} die Default-Werte
     */
    public ImplementableStory() {
        this(new ProductStory(), ImplementState.PENDING);
    }

    /**
     * Instanziiert auf Basis einer Bestehenden {@link ProductStory} eine {@link ImplementableStory}
     * 
     * @param productStory {@link ProductStory}
     * @param implementState {@link ImplementState}
     */
    public ImplementableStory(IProductRequirement productStory, ImplementState implementState) {
        this(productStory.getID(), productStory.getTitle(), productStory.getDescription(),
                productStory.getEstimated(), productStory.getPriority(), productStory.getRequester(),
                productStory.getRequirementKind(), implementState);
    }

    /**
     * Instanziiert eine komplett neue {@link ImplementableStory}
     * 
     * @param id Ein-eindeutige Nummer der Anforderung
     * @param title Titel der Anforderung
     * @param description Beschreibung der Anforderung
     * @param estimated Schtzung der Anforderung
     * @param priority Prioritt der Anforderung
     * @param requester Anforderungsstellers
     * @param requirementKind Anforderungsart
     * @throws IllegalArgumentException wenn die bergeben Parameter den Wertebereich berschreiten
     */
    public ImplementableStory(int id, String title, String description, float estimated, Priority priority,
            String requester, RequirementKind requirementKind, ImplementState implementState)
            throws IllegalArgumentException {
        super(id, title, description, estimated, priority, requester, requirementKind);
        setImplementState(implementState);
        team = new Team(String.valueOf(id) + "-" + title);
    }

    /*
     * (non-Javadoc)
     * @see com.github.jgility.core.requirement.IImplementableRequirement#getImplementState()
     */
    @Override
    public ImplementState getImplementState() {
        return implementState;
    }

    @Override
    public void setImplementState(ImplementState implementState) throws IllegalArgumentException {
        if (ObjectUtils.notEqual(null, implementState)) {
            this.implementState = implementState;
        } else {
            throw new IllegalArgumentException("implementstate has to be not null!");
        }
    }

    @Override
    public Team getAssignee() {
        return team;
    }

    @Override
    public void setAssignee(Team assignee) throws IllegalArgumentException {
        if (ObjectUtils.notEqual(null, assignee)) {
            team = assignee;
        } else {
            throw new IllegalArgumentException("team has to be not null!");
        }
    }

    /*
     * (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return "ImplementableStory [implementState=" + implementState + ", team=" + team + ", getID()=" + getID()
                + ", getTitle()=" + getTitle() + ", getDescription()=" + getDescription() + ", getCreateDate()="
                + getCreateDate() + ", getPriority()=" + getPriority() + ", getRequester()=" + getRequester()
                + ", getRequirementKind()=" + getRequirementKind() + ", getEstimated()=" + getEstimated()
                + ", getEffective()=" + getEffective() + "]";
    }

    @Override
    public int hashCode() {
        HashCodeBuilder builder = new HashCodeBuilder();
        builder.append(super.hashCode());
        builder.append(implementState);
        builder.append(team);
        return builder.toHashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof ImplementableStory) {
            ImplementableStory story = (ImplementableStory) obj;
            EqualsBuilder builder = new EqualsBuilder();
            builder.append(implementState, story.implementState);
            builder.append(team, story.team);
            return builder.isEquals() && super.equals(obj);
        }

        return false;
    }
}