KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > components > source > InspectableSource


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.components.source;
17
18 import org.apache.cocoon.components.source.helpers.SourceProperty;
19
20 import org.apache.excalibur.source.Source;
21 import org.apache.excalibur.source.SourceException;
22
23 /**
24  * A source, which owns meta informations in form of properties
25  *
26  * @author <a HREF="mailto:stephan@vern.chem.tu-berlin.de">Stephan Michels</a>
27  * @version CVS $Id: InspectableSource.java 30932 2004-07-29 17:35:38Z vgritsenko $
28  */
29 public interface InspectableSource extends Source {
30
31     /**
32      * To get a meta information from a source
33      */
34     public SourceProperty getSourceProperty(String JavaDoc namespace, String JavaDoc name) throws SourceException;
35
36     /**
37      * To set a meta information
38      */
39     public void setSourceProperty(SourceProperty property) throws SourceException;
40
41     /**
42      * Get alll informations
43      */
44     public SourceProperty[] getSourceProperties() throws SourceException;
45
46     /**
47      * Remove property
48      */
49     public void removeSourceProperty(String JavaDoc namespace, String JavaDoc name) throws SourceException;
50 }
51
52
Popular Tags