01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components.source;
18:
19: import org.apache.cocoon.components.source.helpers.SourceProperty;
20: import org.apache.excalibur.source.Source;
21: import org.apache.excalibur.source.SourceException;
22:
23: /**
24: * A source descriptor handles modifiable source properties.
25: *
26: * @author <a href="mailto:unico@apache.org">Unico Hommes</a>
27: */
28: public interface SourceDescriptor extends SourceInspector {
29:
30: public static final String ROLE = SourceDescriptor.class.getName();
31:
32: /**
33: * Set a property on a Source.
34: *
35: * @param source the Source to set the SourceProperty on
36: * @param property the SourceProperty to set
37: */
38: public void setSourceProperty(Source source, SourceProperty property)
39: throws SourceException;
40:
41: /**
42: * Remove a property from a Source.
43: *
44: * @param source the Source to remove the property from
45: * @param namespace namespace identifier of the property to remove
46: * @param name name of the property to remove
47: */
48: public void removeSourceProperty(Source source, String namespace,
49: String name) throws SourceException;
50:
51: }
|