src/main/java/com/google/devtools/build/lib/pkgcache/LoadedPackage.java


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

// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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.google.devtools.build.lib.pkgcache;

import com.google.devtools.build.lib.events.Event;

/**
 * A loaded package that can verify whether it is still up to date.
 */
interface LoadedPackage {
  /**
   * Returns the actual loaded {@link Package} object.
   */
  Package getPackage();

  /**
   * Returns true iff the entry is still valid.
   *
   * <p>An entry is valid when the package it denotes has not been moved, deleted, or changed. This
   * requires disk I/O to fetch metadata and re-evaluate globs.
   */
  boolean isValid() throws InterruptedException;

  /**
   * Returns true iff the the contents of the package are guaranteed not to have changed after
   * between {@link #isValid()} calls and syncs of the associated package loader.
   */
  boolean contentsCouldNotHaveChanged();

  /**
   * Returns the set of events (sorted by the order they were reported) that occurred during the
   * loading of the package.
   */
  Iterable<Event> getEvents();
}