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.api.settings;
20
21 /**
22 * Tracks input locations for model fields.
23 * <p>
24 * Implementations store a mapping from keys (usually field names or indices) to
25 * the corresponding InputLocation in the source. Keys must be non-null.
26 */
27 public interface InputLocationTracker {
28 /**
29 * Gets the location of the specified field in the input source.
30 *
31 * @param field the key of the field, must not be {@code null}
32 * @return the location of the field in the input source or {@code null} if unknown
33 * @throws NullPointerException if {@code field} is {@code null}
34 */
35 InputLocation getLocation(Object field);
36 }