base/src/com/google/idea/blaze/base/projectview/section/sections/SyncFlagsSection.java

/*
 * Copyright 2017 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.idea.blaze.base.projectview.section.sections;

import com.google.idea.blaze.base.projectview.parser.ParseContext;
import com.google.idea.blaze.base.projectview.parser.ProjectViewParser;
import com.google.idea.blaze.base.projectview.section.ListSection;
import com.google.idea.blaze.base.projectview.section.ListSectionParser;
import com.google.idea.blaze.base.projectview.section.SectionKey;
import com.google.idea.blaze.base.projectview.section.SectionParser;
import com.google.idea.blaze.base.settings.Blaze;
import javax.annotation.Nullable;

/** Section for blaze_flags */
public class SyncFlagsSection {
  public static final SectionKey<String, ListSection<String>> KEY = SectionKey.of("sync_flags");
  public static final SectionParser PARSER = new SyncFlagsSectionParser();

  static class SyncFlagsSectionParser extends ListSectionParser<String> {
    SyncFlagsSectionParser() {
      super(KEY);
    }

    @Nullable
    @Override
    protected String parseItem(ProjectViewParser parser, ParseContext parseContext) {
      return parseContext.current().text;
    }

    @Override
    protected void printItem(String item, StringBuilder sb) {
      sb.append(item);
    }

    @Override
    public ItemType getItemType() {
      return ItemType.Other;
    }

    @Override
    public String quickDocs() {
      return String.format(
          "A set of flags that get passed to %s build during all sync actions. Unlike"
              + "'build_flags', these are not used for run configurations, so use 'sync_flags' "
              + "only when necessary, as they can defeat %<s caching.",
          Blaze.guessBuildSystemName());
    }
  }
}