import FileInformation from './FileInformation';

/**
 * Class that links Components together.
 * @augments {FileInformation}
 */
class ComponentLink extends FileInformation {
  /**
   * Default constructor.
   * @param {object} [props] - Object that contains all properties to set.
   * @param {string} [props.source] - Id of component can be the source in a link.
   * @param {string} [props.target] - Id of component can be the target of the link.
   * @param {string} [props.name] - Name of the link anchor, link to store where the link begin.
   * @param {ComponentLinkDefinition} [props.definition] - The definition of the link.
   * @param {boolean} [props.isReverse] - Indicate if this link is a reverse link.
   * The purpose of reversing a Link is to switch the start and the end of the link.
   */
  constructor(props = {
    source: null,
    target: null,
    name: null,
    definition: null,
    isReverse: false,
  }) {
    super();
    const {
      source,
      target,
      name,
      definition,
      isReverse,
    } = props;

    /**
     * Use for drawer to get the type of object.
     * @type {string}
     * @private
     */
    this.__class = 'Link';
    /**
     * Where the link is created.
     * @type {object}
     */
    this.source = source || null;
    /**
     * Target of the link.
     * @type {object}
     */
    this.target = target || null;
    /**
     * Name of the link.
     * @type {string}
     */
    this.name = name || null;
    /**
     * The definition of the link.
     * @type {ComponentLinkDefinition}
     */
    this.definition = definition || null;
    /**
     * Indicate if this link is a reverse link.
     * The purpose of reversing a Link is to switch the start and the end of the link.
     * @type {boolean}
     */
    this.isReverse = !!isReverse;
  }
}

export default ComponentLink;