Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 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.felix.scrplugin.helper; |
| 20 | |
| 21 | import java.util.LinkedHashMap; |
| 22 | import java.util.Map; |
| 23 | |
| 24 | import org.apache.felix.scrplugin.description.ClassDescription; |
| 25 | import org.apache.felix.scrplugin.description.ComponentDescription; |
| 26 | import org.apache.felix.scrplugin.description.PropertyDescription; |
| 27 | import org.apache.felix.scrplugin.description.ReferenceDescription; |
| 28 | import org.apache.felix.scrplugin.description.ServiceDescription; |
| 29 | |
| 30 | |
| 31 | /** |
| 32 | * A <code>ComponentContainer</code> contains all relevant information |
| 33 | * about a component: |
| 34 | * - the class descriptor |
| 35 | * - the component descriptor |
| 36 | * - the service descriptor |
| 37 | * - reference descriptors |
| 38 | * - property descriptors |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 39 | */ |
| 40 | public class ComponentContainer { |
| 41 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 42 | /** The class description. */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 43 | private final ClassDescription classDescription; |
| 44 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 45 | /** The component description. */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 46 | private final ComponentDescription componentDescription; |
| 47 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 48 | /** The service description (optional). */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 49 | private ServiceDescription serviceDescription; |
| 50 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 51 | /** All references. */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 52 | private final Map<String, ReferenceDescription> allReferences = new LinkedHashMap<String, ReferenceDescription>(); |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 53 | |
| 54 | /** All properties. */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 55 | private final Map<String, PropertyDescription> allProperties = new LinkedHashMap<String, PropertyDescription>(); |
| 56 | |
Carsten Ziegeler | 646b818 | 2012-08-31 07:47:57 +0000 | [diff] [blame] | 57 | /** Metatype container. */ |
| 58 | private MetatypeContainer metatype; |
Carsten Ziegeler | eb37dc4 | 2012-08-31 07:37:45 +0000 | [diff] [blame] | 59 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 60 | /** |
| 61 | * Create a new component container |
| 62 | * @param classDescription Class description |
| 63 | * @param componentDescription Component description |
| 64 | */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 65 | public ComponentContainer(final ClassDescription classDescription, |
| 66 | final ComponentDescription componentDescription) { |
| 67 | this.classDescription = classDescription; |
| 68 | this.componentDescription = componentDescription; |
| 69 | } |
| 70 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 71 | /** |
| 72 | * Get the class description |
| 73 | * @return The class description |
| 74 | */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 75 | public ClassDescription getClassDescription() { |
| 76 | return this.classDescription; |
| 77 | } |
| 78 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 79 | /** |
| 80 | * Get the component description |
| 81 | * @return The component description |
| 82 | */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 83 | public ComponentDescription getComponentDescription() { |
| 84 | return this.componentDescription; |
| 85 | } |
| 86 | |
Carsten Ziegeler | 651df21 | 2012-06-27 06:48:15 +0000 | [diff] [blame] | 87 | /** |
| 88 | * Get all references. |
| 89 | * The references are put into the map by name. |
| 90 | * This map can be modified by clients. |
| 91 | * @return The map of references |
| 92 | */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 93 | public Map<String, ReferenceDescription> getReferences() { |
| 94 | return this.allReferences; |
| 95 | } |
| 96 | |
Carsten Ziegeler | 283ace9 | 2012-06-27 09:51:56 +0000 | [diff] [blame] | 97 | /** |
| 98 | * Get all properties. |
| 99 | * The properties are put into the map by name. |
| 100 | * This map can be modified by clients. |
| 101 | * @return The map of properties |
| 102 | */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 103 | public Map<String, PropertyDescription> getProperties() { |
| 104 | return this.allProperties; |
| 105 | } |
| 106 | |
Carsten Ziegeler | 283ace9 | 2012-06-27 09:51:56 +0000 | [diff] [blame] | 107 | /** |
| 108 | * Get the service description. |
| 109 | * @return The service description or <code>null</code> |
| 110 | */ |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 111 | public ServiceDescription getServiceDescription() { |
| 112 | return serviceDescription; |
| 113 | } |
| 114 | |
Carsten Ziegeler | 283ace9 | 2012-06-27 09:51:56 +0000 | [diff] [blame] | 115 | /** |
| 116 | * Set the service description |
| 117 | * @param serviceDescription The new service description |
| 118 | */ |
| 119 | public void setServiceDescription(final ServiceDescription serviceDescription) { |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 120 | this.serviceDescription = serviceDescription; |
| 121 | } |
Carsten Ziegeler | 561e4e2 | 2012-06-27 06:38:28 +0000 | [diff] [blame] | 122 | |
| 123 | @Override |
| 124 | public String toString() { |
| 125 | return "ComponentContainer [classDescription=" + classDescription + ", componentDescription=" + componentDescription |
| 126 | + ", serviceDescription=" + serviceDescription + ", allReferences=" + allReferences + ", allProperties=" |
| 127 | + allProperties + "]"; |
| 128 | } |
Carsten Ziegeler | eb37dc4 | 2012-08-31 07:37:45 +0000 | [diff] [blame] | 129 | |
Carsten Ziegeler | 646b818 | 2012-08-31 07:47:57 +0000 | [diff] [blame] | 130 | public MetatypeContainer getMetatypeContainer() { |
| 131 | return this.metatype; |
Carsten Ziegeler | eb37dc4 | 2012-08-31 07:37:45 +0000 | [diff] [blame] | 132 | } |
| 133 | |
Carsten Ziegeler | 646b818 | 2012-08-31 07:47:57 +0000 | [diff] [blame] | 134 | public void setMetatypeContainer(final MetatypeContainer ocd) { |
| 135 | this.metatype = ocd; |
Carsten Ziegeler | eb37dc4 | 2012-08-31 07:37:45 +0000 | [diff] [blame] | 136 | } |
Carsten Ziegeler | 9a496fe | 2012-06-27 06:20:28 +0000 | [diff] [blame] | 137 | } |