com.almworks.jira.structure.api2g.v2.SQueryParser Maven / Gradle / Ivy

Go to download

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

Public API for the Structure Plugin for JIRA

There is a newer version: 17.25.3

package com.almworks.jira.structure.api2g.v2;

import com.almworks.jira.structure.api.StructureException;
import com.almworks.jira.structure.api2g.forest.ForestSpec;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface SQueryParser {
  /**
   *
   * NB: This method returns a ForestSource even for invalid queries.
   *
   *
   * @param sQuery
   * @param userKey
   * @return
   * @throws StructureException
   */
  @NotNull
  ForestSource parseQuery(@NotNull ForestSpec.SQuery sQuery, @Nullable String userKey) throws StructureException;

  //optionally
  //ItemForest buildSkeleton(String query);
}