00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_POF_NAVIGATOR_HPP 00008 #define COH_POF_NAVIGATOR_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/io/pof/reflect/PofValue.hpp" 00013 00014 COH_OPEN_NAMESPACE4(coherence,io,pof,reflect) 00015 00016 00017 /** 00018 * The PofNavigator interface represents an algorithm for navigating a PofValue 00019 * hierarchy in order to locate a contained PofValue for extraction, modification 00020 * and/or removal purposes. 00021 * 00022 * @author as/gm 2009.04.01 00023 * @since Coherence 3.5 00024 */ 00025 class COH_EXPORT PofNavigator 00026 : public interface_spec<PofNavigator> 00027 { 00028 // ----- PofNavigator interface ----------------------------------------- 00029 00030 public: 00031 /** 00032 * Locate the {@link PofValue} designated by this PofNavigator within 00033 * the passed PofValue. 00034 * 00035 * @param hValueOrigin the origin from which navigation starts 00036 * 00037 * @return the resulting PofValue 00038 * 00039 * @throws PofNavigationException if the navigation fails; for 00040 * example one of the intermediate nodes in this path is a 00041 * "terminal" PofValue. 00042 */ 00043 virtual PofValue::Handle navigate(PofValue::Handle hValueOrigin) const = 0; 00044 }; 00045 00046 COH_CLOSE_NAMESPACE4 00047 00048 #endif // COH_POF_NAVIGATOR_HPP