# FlowLink.java

    /*
    ** Module   : FlowLink.java
    ** Abstract : Encodes a single link in the flow chart.
    **
    ** Copyright (c) 2018, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 CA  20181003 First version.
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program 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 Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.report.server;

    /**
     * Defines a link between two nodes in the flow chart.
     */
    public class FlowLink
    {
       /** The link ID. */
       private int id;

       /** The source {@link FlowAstNode node } ID. */
       private int source;

       /** The target {@link FlowAstNode node } ID. */
       private int target;

       /** The link's text.  May be <code>null</code> or empty. */
       private String text;

       /** Marks links which point to an exit node (i.e. from a block to the next statement). */
       private boolean exit;

       /** The link's type. */
       private String type;

       /**
        * Create an instance.
        *
        * @param    id
        *           The link's ID.
        * @param    source
        *           The link's source.
        * @param    target
        *           The link's target.
        * @param    text
        *           The link's text.
        * @param    type
        *           The link's type.
        */
       public FlowLink(int id, int source, int target, String text, String type)
       {
          this.id = id;
          this.source = source;
          this.target = target;
          this.text = text;
          this.type = type;
       }

       /**
        * Get the link's {@link #source}.
        *
        * @return   See above.
        */
       public int getSource()
       {
          return source;
       }

       /**
        * Set the link's {@link #source}.
        *
        * @param    source
        *           The link's source.
        */
       public void setSource(int source)
       {
          this.source = source;
       }

       /**
        * Get the link's {@link #target}.
        *
        * @return   See above.
        */
       public int getTarget()
       {
          return target;
       }

       /**
        * Set the link's {@link #target}.
        *
        * @param    target
        *           The link's target.
        */
       public void setTarget(int target)
       {
          this.target = target;
       }

       /**
        * Get the link's {@link #text}.
        *
        * @return   See above.
        */
       public String getText()
       {
          return text;
       }

       /**
        * Set the link's {@link #text}.
        *
        * @param    text
        *           The link's text.
        */
       public void setText(String text)
       {
          this.text = text;
       }

       /**
        * Get the link's {@link #id}.
        *
        * @return   See above.
        */
       public int getId()
       {
          return id;
       }

       /**
        * Set the link's {@link #id}.
        *
        * @param    id
        *           The link's id.
        */
       public void setId(int id)
       {
          this.id = id;
       }

       /**
        * Get the link's {@link #exit} state.
        *
        * @return   See above.
        */
       public boolean isExit()
       {
          return exit;
       }

       /**
        * Set the link's {@link #exit} state.
        *
        * @param    exit
        *           The exit state.
        */
       public void setExit(boolean exit)
       {
          this.exit = exit;
       }

       /**
        * Get the link's {@link #type}.
        *
        * @return   See above.
        */
       public String getType()
       {
          return type;
       }

       /**
        * Set the link's {@link #type}.
        *
        * @param    type
        *           The link's type.
        */
       public void setType(String type)
       {
          this.type = type;
       }
    }