KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > core > config > node > link > LinkNode


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */
17
18 package org.sape.carbon.core.config.node.link;
19
20 import org.sape.carbon.core.config.format.ConfigurationFormatException;
21 import org.sape.carbon.core.config.node.Node;
22 import org.sape.carbon.core.config.node.NodeIOException;
23
24 /**
25  * <code>LinkNode</code>s are <code>Node</code>s that point to other
26  * <code>Node</code>s within the same or another data store. The primary
27  * example is the root <code>Node</code> of the
28  * <code>ConfigurationService</code>. It is a <code>LinkNode</code> that
29  * points to the location of the root of the configuraiton node graph. This
30  * interface contains methods for reading and writing the
31  * <code>LinkNodeConfiguration</code> that configures the link.
32  *
33  * Copyright 2002 Sapient
34  * @since carbon 1.0
35  * @author Douglas Voet, March 2002
36  * @version $Revision: 1.3 $($Author: dvoet $ / $Date: 2003/05/05 21:21:19 $)
37  */
38 public interface LinkNode extends Node {
39
40     /**
41      * Reads the <code>LinkNodeConfiguration</code> object that configures
42      * this link
43      *
44      * @return LinkNodeConfiguration
45      * @throws NodeIOException if there is an exception reading from the
46      * backing data store
47      * @throws ConfigurationFormatException if the configuration has an
48      * invalid format
49      */
50     LinkNodeConfiguration readLinkConfiguration()
51         throws NodeIOException, ConfigurationFormatException;
52
53     /**
54      * Writes a new <code>LinkNodeConfiguration</code> to the backing data
55      * store. Note that if changing a configuration, changes will not take
56      * effect until the <code>ConfigurationService</code> is reloaded. In
57      * most cases, that is when the system is restarted.
58      *
59      * @param config the new <code>LinkNodeConfiguration</code>
60      * @throws NodeIOException if there is an exception writing to the
61      * backing data store
62      * @throws ConfigurationFormatException if there is a problem formatting
63      * the data
64      */
65     void writeLinkConfiguration(LinkNodeConfiguration config)
66         throws NodeIOException, ConfigurationFormatException;
67 }
68
Popular Tags