de.adrodoc55.minecraft.mpl.ast.chainparts.Dependable Maven / Gradle / Ivy

Go to download
/*
 * Minecraft Programming Language (MPL): A language for easy development of command block
 * applications including an IDE.
 *
 * © Copyright (C) 2016 Adrodoc55
 *
 * This file is part of MPL.
 *
 * MPL is free software: you can redistribute it and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MPL 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 General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with MPL. If not, see
 * .
 *
 *
 *
 * Minecraft Programming Language (MPL): Eine Sprache für die einfache Entwicklung von Commandoblock
 * Anwendungen, inklusive einer IDE.
 *
 * © Copyright (C) 2016 Adrodoc55
 *
 * Diese Datei ist Teil von MPL.
 *
 * MPL ist freie Software: Sie können diese unter den Bedingungen der GNU General Public License,
 * wie von der Free Software Foundation, Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
 * veröffentlichten Version, weiterverbreiten und/oder modifizieren.
 *
 * MPL wird in der Hoffnung, dass es nützlich sein wird, aber OHNE JEDE GEWÄHRLEISTUNG,
 * bereitgestellt; sogar ohne die implizite Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN
 * BESTIMMTEN ZWECK. Siehe die GNU General Public License für weitere Details.
 *
 * Sie sollten eine Kopie der GNU General Public License zusammen mit MPL erhalten haben. Wenn
 * nicht, siehe .
 */
package de.adrodoc55.minecraft.mpl.ast.chainparts;

import de.adrodoc55.minecraft.mpl.commands.Mode;

/**
 * @author Adrodoc55
 */
public interface Dependable {
  /**
   * Returns whether a following CONDITIONAL or INVERT {@link ChainPart} can depend on this.
   * 
   * Subclasses that are dependable should override this method along with
   * {@link #getModeForInverting()}.
   *
   * @return whether a following {@link ChainPart} can depend on this
   */
  default boolean canBeDependedOn() {
    return false;
  }

  /**
   * Returns the {@link Mode} that should be used for an invert depending on this {@link ChainPart}
   * (optional operation).
   * 
   * Subclasses that are dependable should override this method along with
   * {@link #canBeDependedOn()}.
   *
   * @return the {@link Mode} of this {@link ChainPart}
   * @throws UnsupportedOperationException if this {@link ChainPart} is not dependable as defined by
   *         {@link #canBeDependedOn()}
   */
  default Mode getModeForInverting() throws UnsupportedOperationException {
    throw new UnsupportedOperationException(
        "The class " + getClass() + " is not dependable and does not have a mode");
  }
}