summaryrefslogtreecommitdiffstats
path: root/sched/src/com/android/sched/vfs/BaseVFS.java
blob: eb425763a08ea0f7595da67e7c4c29cba806a0db (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
/*
 * Copyright (C) 2015 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.vfs;

import com.android.sched.util.file.CannotCreateFileException;
import com.android.sched.util.file.CannotDeleteFileException;
import com.android.sched.util.file.NoSuchFileException;
import com.android.sched.util.file.NotDirectoryException;
import com.android.sched.util.file.NotFileException;
import com.android.sched.util.file.WrongPermissionException;
import com.android.sched.util.location.Location;

import java.io.InputStream;
import java.io.OutputStream;
import java.util.Collection;

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

/**
 * A base implementation of a {@link VFS}.
 */
abstract class BaseVFS<DIR extends BaseVDir, FILE extends BaseVFile> implements VFS {
  protected boolean closed = false;

  @Override
  @Nonnull
  public abstract DIR getRootDir();

  //
  // Stream related
  //

  @Nonnull
  abstract InputStream openRead(@Nonnull FILE file) throws WrongPermissionException;

  @Nonnull
  abstract OutputStream openWrite(@Nonnull FILE file) throws WrongPermissionException;

  //
  // VElement related
  //

  @Nonnull
  abstract DIR getVDir(@Nonnull DIR parent, @Nonnull String name) throws NotDirectoryException,
  NoSuchFileException;

  @Nonnull
  abstract FILE getVFile(@Nonnull DIR parent, @Nonnull String name) throws NotFileException,
  NoSuchFileException;

  @Nonnull
  abstract DIR createVDir(@Nonnull DIR parent, @Nonnull String name)
    throws CannotCreateFileException;

  @Nonnull
  abstract FILE createVFile(@Nonnull DIR parent, @Nonnull String name)
      throws CannotCreateFileException;

  @Nonnull
  abstract void delete(@Nonnull FILE file) throws CannotDeleteFileException;

  @Nonnull
  abstract Collection<? extends BaseVElement> list(@Nonnull DIR dir);

  abstract boolean isEmpty(@Nonnull DIR dir);

  //
  // Location related
  //

  @Nonnull
  abstract Location getVFileLocation(@Nonnull FILE file);

  @Nonnull
  abstract Location getVFileLocation(@Nonnull DIR parent, @Nonnull String name);

  @Nonnull
  abstract Location getVFileLocation(@Nonnull DIR parent, @Nonnull VPath path);

  @Nonnull
  abstract Location getVDirLocation(@Nonnull DIR dir);

  @Nonnull
  abstract Location getVDirLocation(@Nonnull DIR parent, @Nonnull String name);

  @Nonnull
  abstract Location getVDirLocation(@Nonnull DIR parent, @Nonnull VPath path);

  //
  // Misc
  //

  synchronized boolean isClosed() {
    return closed;
  }

  @Override
  @CheckForNull
  public String getDigest() {
    return null;
  }
}