/*-
 * -\-\-
 * github-api
 * --
 * Copyright (C) 2016 - 2020 Spotify AB
 * --
 * 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.spotify.github.v3.git;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.spotify.github.GithubStyle;
import javax.annotation.Nullable;
import org.immutables.value.Value;

/** Git tree item. */
@Value.Immutable
@GithubStyle
@JsonSerialize(as = ImmutableTreeItem.class)
@JsonDeserialize(as = ImmutableTreeItem.class)
public interface TreeItem extends ShaLink {

  /** The file referenced in the tree. */
  @Nullable
  String path();

  /**
   * The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for
   * subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the
   * path of a symlink.
   */
  @Nullable
  String mode();

  /** Either blob, tree, or commit. */
  @Nullable
  String type();

  /** File size in bytes. */
  @Nullable
  Long size();
}
