org.apache.cayenne.graph.GraphChangeHandler Maven / Gradle / Ivy
/*****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.cayenne.graph;
/**
* Defines callback API that can be used by object graph nodes to notify of their state
* changes. Graph nodes can be any objects as long as each node supports a notion of a
* unique id within the graph and each directional arc has a unique identifier within its
* source node.
*
* @since 1.2
*/
public interface GraphChangeHandler {
/**
* Notifies implementing object that a node was assigned a new id.
*/
void nodeIdChanged(Object nodeId, Object newId);
/**
* Notifies implementing object that a new node was created in the graph.
*/
void nodeCreated(Object nodeId);
/**
* Notifies implementing object that a node was removed from the graph.
*/
void nodeRemoved(Object nodeId);
/**
* Notifies implementing object that a node's property was modified.
*/
void nodePropertyChanged(
Object nodeId,
String property,
Object oldValue,
Object newValue);
/**
* Notifies implementing object that a new arc was created between two nodes.
*/
void arcCreated(Object nodeId, Object targetNodeId, Object arcId);
/**
* Notifies implementing object that an arc between two nodes was deleted.
*/
void arcDeleted(Object nodeId, Object targetNodeId, Object arcId);
}