View Javadoc

1   /*
2    * Copyright (c) 2005 The University of Reading
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    * 1. Redistributions of source code must retain the above copyright
9    *    notice, this list of conditions and the following disclaimer.
10   * 2. Redistributions in binary form must reproduce the above copyright
11   *    notice, this list of conditions and the following disclaimer in the
12   *    documentation and/or other materials provided with the distribution.
13   * 3. Neither the name of the University of Reading, nor the names of the
14   *    authors or contributors may be used to endorse or promote products
15   *    derived from this software without specific prior written permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20   * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   */
28  
29  package uk.ac.rdg.resc.jstyx.gridservice.config;
30  
31  import java.io.File;
32  
33  /***
34   * Description of DocFile goes here.
35   *
36   * @author Jon Blower
37   * $Revision: 465 $
38   * $Date: 2005-11-07 20:59:34 +0000 (Mon, 07 Nov 2005) $
39   * $Log$
40   * Revision 1.1  2005/11/07 20:59:34  jonblower
41   * Refactored SGS config classes to new package
42   *
43   */
44  
45  public class DocFile
46  {
47      private String name;  // The name of the file as it will appear in the namespace
48      private File location; // The location of the file in the host filesystem
49      
50      public DocFile(String name, String location)
51      {
52          this.location = new File(location);
53          this.name = name.trim();
54          // if the name is blank, set the name to the last part of the location
55          if (this.name.equals(""))
56          {
57              this.name = this.location.getName();
58          }
59      }
60      
61      /***
62       * @return the name of the documentation file as it will appear in 
63       * the namespace of the SGS
64       */
65      public String getName()
66      {
67          return this.name;
68      }
69      
70      /***
71       * @return the location of the file in the host filesystem
72       */
73      public File getLocation()
74      {
75          return this.location;
76      }
77  }