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.myfaces.debug;
20
21 import javax.faces.view.Location;
22
23 /**
24 * Identification inferface for types that know about {@link Location}.
25 *
26 * If type implements this interface, we can say that it knows where
27 * instance implementing this interfaces is located in facelets view.
28 *
29 * {@link javax.faces.component.UIComponent} is LocationAware-like, because
30 * it knows it's Location: {@link javax.faces.component.UIComponent#VIEW_LOCATION_KEY}
31 *
32 * @author martinkoci
33 *
34 * @see Location
35 */
36 public interface LocationAware
37 {
38
39 /**
40 * @return the {@link Location} instance where this object exists/is related to
41 */
42 Location getLocation();
43
44 }