com.helger.graph.IMutableDirectedGraphNode Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.graph;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.state.EChange;

/**
 * Base interface for graph node implementations.
 *
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
public interface IMutableDirectedGraphNode extends
                                           IMutableBaseGraphNode ,
                                           IDirectedGraphNode 
{
  /**
   * Add a new incoming relation to this node
   *
   * @param aRelation
   *        The relation to be added. May not be null.
   */
  void addIncomingRelation (@Nonnull IMutableDirectedGraphRelation aRelation);

  /**
   * Remove the passed relation from the set of incoming relations.
   *
   * @param aRelation
   *        The relation to be removed. May be null.
   * @return {@link EChange#CHANGED} if the passed relation was successfully
   *         removed from the incoming relations.
   */
  @Nonnull
  EChange removeIncomingRelation (@Nullable IMutableDirectedGraphRelation aRelation);

  /**
   * Remove all incoming relations.
   *
   * @return {@link EChange#CHANGED} if the at least one relation was
   *         successfully removed from the incoming relations.
   */
  @Nonnull
  EChange removeAllIncomingRelations ();

  /**
   * Add a new outgoing relation from this node
   *
   * @param aRelation
   *        The relation to be added. May not be null.
   */
  void addOutgoingRelation (@Nonnull IMutableDirectedGraphRelation aRelation);

  /**
   * Remove the passed relation from the set of outgoing relations.
   *
   * @param aRelation
   *        The relation to be removed. May be null.
   * @return {@link EChange#CHANGED} if the passed relation was successfully
   *         removed from the outgoing relations.
   */
  @Nonnull
  EChange removeOutgoingRelation (@Nullable IMutableDirectedGraphRelation aRelation);

  /**
   * Remove all outgoing relations.
   *
   * @return {@link EChange#CHANGED} if the at least one relation was
   *         successfully removed from the outgoing relations.
   */
  @Nonnull
  EChange removeAllOutgoingRelations ();

  @Nonnull
  default EChange removeAllRelations ()
  {
    EChange ret = EChange.UNCHANGED;
    ret = ret.or (removeAllIncomingRelations ());
    ret = ret.or (removeAllOutgoingRelations ());
    return ret;
  }
}