/*
 * SonarQube
 * Copyright (C) 2009-2023 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.es.newindex;

import static org.sonar.server.es.newindex.DefaultIndexSettings.FIELD_TYPE_TEXT;

public class TextFieldBuilder<U extends FieldAware<U>> extends StringFieldBuilder<U, TextFieldBuilder<U>> {

  private boolean fieldData = false;

  protected TextFieldBuilder(U indexType, String fieldName) {
    super(indexType, fieldName);
  }

  protected String getFieldType() {
    return FIELD_TYPE_TEXT;
  }

  /**
   * Required to enable sorting, aggregation and access to field data on fields of type "text".
   * <p>Disabled by default as this can have significant memory cost</p>
   */
  public StringFieldBuilder withFieldData() {
    this.fieldData = true;
    return this;
  }

  @Override
  protected boolean getFieldData() {
    return fieldData;
  }
}
