From c2ca8e689f068bc5d5a86401d9a56303e9fb3f5f Mon Sep 17 00:00:00 2001 From: Amit Kumar Mondal Date: Thu, 6 Jun 2024 11:21:13 +0200 Subject: [PATCH] Added missing comments to PackageDTO --- .../console/data/provider/PackageDTO.java | 33 +++++++++++++------ 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/com.osgifx.console.api/src/main/java/com/osgifx/console/data/provider/PackageDTO.java b/com.osgifx.console.api/src/main/java/com/osgifx/console/data/provider/PackageDTO.java index 61e161d8..57a8420a 100644 --- a/com.osgifx.console.api/src/main/java/com/osgifx/console/data/provider/PackageDTO.java +++ b/com.osgifx.console.api/src/main/java/com/osgifx/console/data/provider/PackageDTO.java @@ -1,15 +1,15 @@ /******************************************************************************* - * Copyright 2021-2024 Amit Kumar Mondal + * COPYRIGHT 2021-2024 AMIT KUMAR MONDAL * * Licensed under the Apache License, Version 2.0 (the "License"); you may not - * use this file except in compliance with the License. You may obtain a copy - * of the License at + * use this file except in compliance with the License. You may obtain a copy + * of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the * License for the specific language governing permissions and limitations under * the License. ******************************************************************************/ @@ -17,17 +17,30 @@ import java.util.ArrayList; import java.util.List; - import org.osgi.dto.DTO; - import com.osgifx.console.agent.dto.XBundleDTO; +/** + * A Data Transfer Object (DTO) representing package information. + * It includes details about the package name, version, and whether + * it is duplicated when exported. Additionally, it holds lists of + * exporters and importers associated with the package. + */ public class PackageDTO extends DTO { - public String name; - public String version; - public boolean isDuplicateExport; + /** The name of the package. */ + public String name; + + /** The version of the package. */ + public String version; + + /** Indicates whether the package is duplicated when exported. */ + public boolean isDuplicateExport; + + /** List of bundles exporting this package. */ public List exporters = new ArrayList<>(); + + /** List of bundles importing this package. */ public List importers = new ArrayList<>(); -} \ No newline at end of file +}