1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36 package org.exolab.castor.xml;
37
38 /**
39 * A class used to indicate access rights
40 *
41 * @author <a href="kvisco@intalio.com">Keith Visco</a>
42 * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
43 **/
44 public class AccessRights {
45
46 /**
47 * The type that indicates both read and write access
48 **/
49 public static final short BOTH = 0;
50
51 /**
52 * The type that indicates only read access
53 **/
54 public static final short READ = 1;
55
56 /**
57 * The type that indicates only write access
58 **/
59 public static final short WRITE = 2;
60
61
62 /**
63 * A read and write AccessRights
64 **/
65 public static final AccessRights both = new AccessRights(AccessRights.BOTH);
66
67 /**
68 * A read-only AccessRights
69 **/
70 public static final AccessRights read = new AccessRights(AccessRights.READ);
71
72 /**
73 * A write-only AccessRights
74 **/
75 public static final AccessRights write = new AccessRights(AccessRights.WRITE);
76
77 /**
78 * The type of this AccessRights
79 **/
80 private short type = BOTH;
81
82 /**
83 * Creates a default AccessRights with both read and write privileges
84 **/
85 private AccessRights() {
86 super();
87 } // -- AccessRights
88
89 /**
90 * Creates a new AccessRights with the privilege set to the given type
91 *
92 * @param type the type of privilege to be granted
93 **/
94 private AccessRights(short type) {
95 this.type = type;
96 } // -- AccessRights
97
98 /**
99 * Returns the type of this Access
100 **/
101 public short getType() {
102 return type;
103 } // -- getType
104
105
106 /**
107 * Returns true if this AccessRights allows reading
108 *
109 * @return true if this AccessRights allows reading, otherwise false.
110 **/
111 public boolean isReadable() {
112 return ((type == BOTH) || (type == READ));
113 } // -- isReadable
114
115 /**
116 * Returns true if this AccessRights allows writing
117 *
118 * @return true if this AccessRights allows writing, otherwise false.
119 **/
120 public boolean isWritable() {
121 return ((type == BOTH) || (type == WRITE));
122 } // -- isWritable
123
124
125 } // -- AccessRights