View Javadoc

1   ////////////////////////////////////////////////////////////////////////////////
2   // MillScript: an Open Spice interpreter and batch website creation tool
3   // Copyright (C) 2005 Kevin Rogers
4   //
5   // This file is part of MillScript.
6   //
7   // MillScript is free software; you can redistribute it and/or modify it under
8   // the terms of the GNU General Public License as published by the Free
9   // Software Foundation; either version 2 of the License, or (at your option)
10  // any later version.
11  //
12  // MillScript is distributed in the hope that it will be useful, but WITHOUT
13  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  // more details.
16  //
17  // You should have received a copy of the GNU General Public License along with
18  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19  // Place, Suite 330, Boston, MA  02111-1307  USA
20  ////////////////////////////////////////////////////////////////////////////////
21  package org.millscript.commons.vfs.util;
22  
23  import org.millscript.commons.vfs.AbstractVVolume;
24  import org.millscript.commons.vfs.VFolder;
25  
26  import java.net.URI;
27  
28  /**
29   * This class provides a simple volume, which is a non-existant volume using a
30   * virtual filesystem folder as its root.
31   */
32  public class SimpleVolume extends AbstractVVolume {
33  
34      /**
35       * This is the virtual folder from which this volume is made.
36       */
37      private final VFolder parentVFolder;
38  
39      /**
40       * Constructs a new simple volume for the specified folder.
41       *
42       * @param rootFolder    the VFolder that is the root of this volume
43       */
44      public SimpleVolume( final VFolder rootFolder ) {
45          super( rootFolder.getVolume().getParentVFS() );
46          this.parentVFolder = rootFolder;
47      }
48  
49      /**
50       * @see org.millscript.commons.vfs.VVolume#getURI()
51       */
52      public URI getURI() {
53          return this.getRootVFolder().getURI();
54      }
55  
56      /**
57       * @see org.millscript.commons.vfs.VVolume#getRootVFolder()
58       */
59      public VFolder getRootVFolder() {
60          return this.parentVFolder;
61      }
62  
63  }