View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.search.api.request;
20  
21  import static java.util.Objects.requireNonNull;
22  
23  /**
24   * Field query.
25   */
26  public class FieldQuery extends Query {
27      private final Field field;
28  
29      protected FieldQuery(Field field, String queryString) {
30          super(queryString);
31          this.field = requireNonNull(field);
32      }
33  
34      /**
35       * Returns the field, never {@code null}.
36       */
37      public Field getField() {
38          return field;
39      }
40  
41      @Override
42      public String toString() {
43          return getField().getFieldName() + ":" + getValue();
44      }
45  
46      /**
47       * Creates a field query using given {@link Field} and query string.
48       */
49      public static FieldQuery fieldQuery(Field fieldName, String query) {
50          return new FieldQuery(fieldName, query);
51      }
52  }