summaryrefslogtreecommitdiffstats
path: root/sched/src/com/android/sched/util/file/AbstractStreamFile.java
blob: 6bd4b94256d921b4fd4e087f50b7be53b7b9ace8 (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
/*
 * Copyright (C) 2013 The Android Open Source 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.android.sched.util.file;

import com.android.sched.util.RunnableHooks;
import com.android.sched.util.location.FileLocation;
import com.android.sched.util.location.Location;
import com.android.sched.util.log.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

/**
 * Abstract class representing a stream from a file path or a standard input/output.
 */
public abstract class AbstractStreamFile extends FileOrDirectory {
  @Nonnull
  private static final Logger  logger = LoggerFactory.getLogger();
  @CheckForNull
  protected final File    file;

  protected AbstractStreamFile(@Nonnull String name,
      @CheckForNull RunnableHooks hooks) {
    super(hooks);

    this.file = new File(name);
    this.location = new FileLocation(file);
  }

  protected AbstractStreamFile(@Nonnull Location location) {
    super(null);
    this.file = null;
    this.location = location;
  }

  protected void performChecks(@Nonnull Existence existence, int permissions,
      @Nonnull ChangePermission change)
      throws NoSuchFileException,
      NotFileException,
      WrongPermissionException,
      FileAlreadyExistsException,
      CannotCreateFileException,
      CannotSetPermissionException {
    assert file != null;

    if (existence == Existence.MAY_EXIST) {
      if (file.exists()) {
        existence = Existence.MUST_EXIST;
      } else {
        existence = Existence.NOT_EXIST;
      }
    }

    switch (existence) {
      case MUST_EXIST:
        AbstractStreamFile.check(file, (FileLocation) location);
        FileOrDirectory.checkPermissions(file, location, permissions);
        break;
      case NOT_EXIST:
        AbstractStreamFile.create(file, location);
        addRemover(file);
        FileOrDirectory.setPermissions(file, location, permissions, change);
        FileOrDirectory.checkPermissions(file, location, permissions);
        break;
      case MAY_EXIST:
        throw new AssertionError();
    }
  }

  public boolean isStandard() {
    return this.file == null;
  }

  @Override
  @Nonnull
  public String toString() {
    return location.getDescription();
  }

  public static void create(@Nonnull File file, @Nonnull Location location)
      throws FileAlreadyExistsException, CannotCreateFileException {
    assert file != null;

    // Check existing
    if (file.exists()) {
      throw new FileAlreadyExistsException(location);
    }

    // Create file
    try {
      if (file.createNewFile()) {
        logger.log(Level.FINE, "Create {0} (''{1}'')",
            new Object[] {location.getDescription(), file.getAbsoluteFile()});
      } else {
        throw new CannotCreateFileException(location);
      }
    } catch (IOException e) {
      throw new CannotCreateFileException(location);
    }
  }

  public static void check(@Nonnull File file, @Nonnull FileLocation location)
      throws NoSuchFileException, NotFileException {
    assert file != null;

    // Check existing
    if (!file.exists()) {
      throw new NoSuchFileException(location);
    }

    // Check if it is not a Directory
    if (file.isDirectory()) {
      throw new NotFileException(location);
    }
  }

  @Override
  @Nonnull
  public String getPath() {
    return ((FileLocation) location).getPath();
  }
}