com.link_intersystems.graph.NodeCycleDetector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lis-commons-graph Show documentation

Link Intersystems Commons Graph (lis-commons-graph) is a collection of reusable software components that provide support for graph and tree related programming tasks, such as models and search algorithms.

There is a newer version: 1.9.7

Show newest version

/**
 * Copyright 2011 Link Intersystems GmbH 
 * 
 * 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.link_intersystems.graph;

import java.util.function.Consumer;

/**
 * A {@link Consumer} that detects cycles when iterating a {@link Node} structure
 * and throws a {@link CyclicGraphException} if a cycle is detected.
 *
 * @author René Link [rene.link@link-
 *         intersystems.com]
 * @since 1.0.0;
 */
public class NodeCycleDetector extends CycleDetector {

    @Override
    protected Object getIdentityObject(Node element) {
        return element.getUserObject();
    }

    @Override
    protected CycleException createCycleException(Node cycleCause) {
        return new CyclicGraphException(cycleCause);
    }
}