com.google.gerrit.server.change.ChangeEditResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation

API for Gerrit Plugins

There is a newer version: 3.11.0-rc3

// Copyright (C) 2014 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.google.gerrit.server.change;

import com.google.gerrit.extensions.restapi.RestResource;
import com.google.gerrit.extensions.restapi.RestView;
import com.google.gerrit.server.edit.ChangeEdit;
import com.google.inject.TypeLiteral;

/**
 * Represents change edit resource, that is actually two kinds of resources:
 *
 * 
 *   the change edit itself
 *   
a path within the edit
 * 
 *
 * distinguished by whether path is null or not.
 */
public class ChangeEditResource implements RestResource {
  public static final TypeLiteral> CHANGE_EDIT_KIND =
      new TypeLiteral<>() {};

  private final ChangeResource change;
  private final ChangeEdit edit;
  private final String path;

  public ChangeEditResource(ChangeResource change, ChangeEdit edit, String path) {
    this.change = change;
    this.edit = edit;
    this.path = path;
  }

  // TODO(davido): Make this cacheable.
  // Should just depend on the SHA-1 of the edit itself.
  public boolean isCacheable() {
    return false;
  }

  public ChangeResource getChangeResource() {
    return change;
  }

  public ChangeEdit getChangeEdit() {
    return edit;
  }

  public String getPath() {
    return path;
  }
}