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
22
23 /**
24 * Identification inferface for types that know about {@link javax.faces.view.Location}
25 * and XML attribute name/value pair.
26 *
27 * <ol>
28 * <li>Location - location instance - see {@link LocationAware}</li>
29 * <li>expressionString - expression String {@link javax.el.Expression#getExpressionString()}</li>
30 * <li>qName - the qualified name for attribute {@link javax.faces.view.facelets.TagAttribute#getQName()}</li>
31 * </ol>
32 *
33 * If type implements this interface, we can say that it knows where instance implementing this
34 * interface is located in facelets view (line/column)
35 * and what XML attribute (name/value pair) makes it.
36 *
37 * Also you can think about this type as about ligthweight version of {@link TagAttributeAware}
38 * for cases, where full TagAttribute instance is not available
39 *
40 * @author martinkoci
41 */
42 public interface LocationAndTagAttributeAware extends LocationAware
43 {
44
45
46 /**
47 * @return expression string, for example "#{bean.actionMethod}" or "success"
48 */
49 public abstract String getExpressionString();
50
51 /**
52 * @return qName of XML attribute, for example "action" or "value"
53 */
54 public abstract String getQName();
55
56 }