View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      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.commons.vfs.provider;
18  
19  import org.apache.commons.logging.Log;
20  import org.apache.commons.vfs.FileSystemException;
21  
22  /***
23   * A partial {@link VfsComponent} implementation.
24   *
25   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
26   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
27   */
28  public abstract class AbstractVfsComponent
29      implements VfsComponent
30  {
31      private VfsComponentContext context;
32      private Log log;
33  
34      /***
35       * Sets the Logger to use for the component.
36       */
37      public final void setLogger(final Log log)
38      {
39          this.log = log;
40      }
41  
42      /***
43       * Sets the context for this file system provider.
44       */
45      public final void setContext(final VfsComponentContext context)
46      {
47          this.context = context;
48      }
49  
50      /***
51       * Initialises the component.  This implementation does nothing.
52       */
53      public void init() throws FileSystemException
54      {
55      }
56  
57      /***
58       * Closes the provider.  This implementation does nothing.
59       */
60      public void close()
61      {
62      }
63  
64      /***
65       * Returns the logger for this file system to use.
66       */
67      protected final Log getLogger()
68      {
69          return log;
70      }
71  
72      /***
73       * Returns the context for this provider.
74       */
75      protected final VfsComponentContext getContext()
76      {
77          return context;
78      }
79  }