KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.apache.excalibur.source.Source;
20 import org.apache.excalibur.source.SourceException;
21
22 /**
23  * A source descriptor handles modifiable source properties.
24  *
25  * @author <a HREF="mailto:unico@apache.org">Unico Hommes</a>
26  */
27 public interface SourceDescriptor extends SourceInspector {
28
29     public static final String JavaDoc ROLE = SourceDescriptor.class.getName();
30     
31     /**
32      * Set a property on a Source.
33      *
34      * @param source the Source to set the SourceProperty on
35      * @param property the SourceProperty to set
36      */
37     public void setSourceProperty(Source source, SourceProperty property)
38         throws SourceException;
39     
40     /**
41      * Remove a property from a Source.
42      *
43      * @param source the Source to remove the property from
44      * @param namespace namespace identifier of the property to remove
45      * @param name name of the property to remove
46      */
47     public void removeSourceProperty(Source source, String JavaDoc namespace, String JavaDoc name)
48         throws SourceException;
49
50 }
51
Popular Tags