aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/cyanogenmod/filemanager/model/Permission.java
blob: 38900a7bb53af2f7e2981d7ee5f0321720d42a8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/*
 * Copyright (C) 2012 The CyanogenMod Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.cyanogenmod.filemanager.model;

import java.io.Serializable;

/**
 * A class for represents permissions.<br/>
 * <br/>
 * Actual permissions refers to Unix permissions:
 * <ul>
 *  <li>read</li>
 *  <li>write</li>
 *  <li>execute</li>
 * </ul>
 */
public abstract class Permission implements Serializable {

    private static final long serialVersionUID = 5775987092282897912L;

    /**
     * @hide
     */
    public static final char UNASIGNED = '-';
    /**
     * @hide
     */
    public static final char READ = 'r';
    /**
     * @hide
     */
    public static final char WRITE = 'w';
    /**
     * @hide
     */
    public static final char EXECUTE = 'x';

    private boolean mRead;
    private boolean mWrite;
    private boolean mExecute;

    private String mRawString;

    /**
     * Constructor of <code>Permission</code>.
     *
     * @param read If the object can be read
     * @param write If the object can be written
     * @param execute If the object can be executed
     */
    public Permission(boolean read, boolean write, boolean execute) {
        super();
        this.mRead = read;
        this.mWrite = write;
        this.mExecute = execute;
    }

    /**
     * Method that returns if the object can be read.
     *
     * @return boolean If the object can be read
     */
    public boolean isRead() {
        return this.mRead;
    }

    /**
     * Method that sets if the object can be read.
     *
     * @param read If the object can be read
     */
    public void setRead(boolean read) {
        this.mRead = read;
        invalidateRawString();
    }

    /**
     * Method that returns if the object can be written.
     *
     * @return boolean If the object can be written
     */
    public boolean isWrite() {
        return this.mWrite;
    }

    /**
     * Method that sets if the object can be written.
     *
     * @param write If the object can be written
     */
    public void setWrite(boolean write) {
        this.mWrite = write;
        invalidateRawString();
    }

    /**
     * Method that returns if the object can be executed.
     *
     * @return boolean If the object can be executed
     */
    public boolean isExecute() {
        return this.mExecute;
    }

    /**
     * Method that sets if the object can be executed.
     *
     * @param execute If the object can be executed
     */
    public void setExecute(boolean execute) {
        this.mExecute = execute;
        invalidateRawString();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + (this.mExecute ? 1231 : 1237);
        result = prime * result + (this.mRead ? 1231 : 1237);
        result = prime * result + (this.mWrite ? 1231 : 1237);
        return result;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        Permission other = (Permission) obj;
        if (this.mExecute != other.mExecute) {
            return false;
        }
        if (this.mRead != other.mRead) {
            return false;
        }
        if (this.mWrite != other.mWrite) {
            return false;
        }
        return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return "Permission [read=" + this.mRead + ", write=" + //$NON-NLS-1$ //$NON-NLS-2$
                 this.mWrite +   ", execute=" + this.mExecute + "]"; //$NON-NLS-1$ //$NON-NLS-2$
    }

    /**
     * Method that returns a string representation of the permissions
     * conforming with the unix style (rwx).
     *
     * @return String The string representation of the permissions
     */
    public String toRawString() {
        if (mRawString == null) {
            mRawString = getRawString();
        }
        return mRawString;
    }

    protected void invalidateRawString() {
        mRawString = null;
    }
    protected abstract String getRawString();
}