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