View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.config;
18  
19  import org.apache.logging.log4j.Logger;
20  import org.apache.logging.log4j.core.config.plugins.Plugin;
21  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
22  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
23  import org.apache.logging.log4j.core.config.plugins.PluginValue;
24  import org.apache.logging.log4j.status.StatusLogger;
25  
26  /**
27   * Represents a key/value pair in the configuration.
28   */
29  @Plugin(name = "property", category = "Core", printObject = true)
30  public final class Property {
31  
32      private static final Logger LOGGER = StatusLogger.getLogger();
33  
34      private final String name;
35      private final String value;
36  
37      private Property(final String name, final String value) {
38          this.name = name;
39          this.value = value;
40      }
41  
42      /**
43       * Returns the property name.
44       * @return the property name.
45       */
46      public String getName() {
47          return name;
48      }
49  
50      /**
51       * Returns the property value.
52       * @return the value of the property.
53       */
54      public String getValue() {
55          return value;
56      }
57  
58      /**
59       * Create a Property.
60       * @param key The key.
61       * @param value The value.
62       * @return A Property.
63       */
64      @PluginFactory
65      public static Property createProperty(
66              @PluginAttribute("name") final String key,
67              @PluginValue("value") final String value) {
68          if (key == null) {
69              LOGGER.error("Property key cannot be null");
70          }
71          return new Property(key, value);
72      }
73  
74      @Override
75      public String toString() {
76          return name + '=' + value;
77      }
78  }