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.logging;
20
21 /**
22 * Object representation of log key.
23 */
24 public interface MyfacesLogKey
25 {
26
27 /**
28 * Returns String representation of this log key.
29 *
30 * Q: why is this method name(), not getName()? A: java enum can out of the box
31 * implement this interface - {@link Enum#name()}
32 *
33 * @return String reprezentation of log key
34 */
35 String name();
36
37 }