Line data    Source code

       1             : // Copyright (C) 2020 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.entities;
      16             : 
      17             : import com.google.auto.value.AutoValue;
      18             : import com.google.common.collect.ImmutableMap;
      19             : 
      20             : /** An entity class representing all context lines of a comment. */
      21             : @AutoValue
      22           2 : public abstract class CommentContext {
      23           2 :   private static final CommentContext EMPTY = new AutoValue_CommentContext(ImmutableMap.of(), "");
      24             : 
      25             :   public static CommentContext create(ImmutableMap<Integer, String> lines, String contentType) {
      26           2 :     return new AutoValue_CommentContext(lines, contentType);
      27             :   }
      28             : 
      29             :   /** Map of {line number, line text} of the context lines of a comment */
      30             :   public abstract ImmutableMap<Integer, String> lines();
      31             : 
      32             :   /**
      33             :    * Content type of the source file. Useful for syntax highlighting.
      34             :    *
      35             :    * @return text/x-gerrit-commit-message if the file is a commit message.
      36             :    *     <p>text/x-gerrit-merge-list if the file is a merge list.
      37             :    *     <p>The content/mime type, e.g. text/x-c++src otherwise.
      38             :    */
      39             :   public abstract String contentType();
      40             : 
      41             :   public static CommentContext empty() {
      42           1 :     return EMPTY;
      43             :   }
      44             : }