org.eclipse.esmf.aspectmodel.loader.MetaModelBaseAttributes Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of esmf-aspect-meta-model-java Show documentation
ESMF SDK
There is a newer version: 2.9.5
Show newest version
/*
 * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
 *
 * See the AUTHORS file(s) distributed with this work for additional
 * information regarding authorship.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * SPDX-License-Identifier: MPL-2.0
 */

package org.eclipse.esmf.aspectmodel.loader;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;

import org.eclipse.esmf.aspectmodel.AspectModelFile;
import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
import org.eclipse.esmf.metamodel.HasDescription;
import org.eclipse.esmf.metamodel.ModelElement;
import org.eclipse.esmf.metamodel.datatype.LangString;

/**
 * Wrapper class for the attributes all Aspect Meta Model elements have.
 */
public class MetaModelBaseAttributes implements HasDescription {
   private final AspectModelUrn urn;
   private final Set preferredNames;
   private final Set descriptions;
   private final List see;
   private final boolean isAnonymous;
   private final AspectModelFile sourceFile;

   private MetaModelBaseAttributes(
         final AspectModelUrn urn,
         final Set preferredNames,
         final Set descriptions,
         final List see,
         final boolean isAnonymous,
         final AspectModelFile sourceFile
   ) {
      this.urn = urn;
      this.preferredNames = preferredNames;
      this.descriptions = descriptions;
      this.see = see;
      this.isAnonymous = isAnonymous;
      this.sourceFile = sourceFile;
   }

   public AspectModelUrn urn() {
      return urn;
   }

   @Override
   public String getName() {
      return urn.getName();
   }

   @Override
   public Set getPreferredNames() {
      return preferredNames;
   }

   @Override
   public Set getDescriptions() {
      return descriptions;
   }

   @Override
   public List getSee() {
      return see;
   }

   public boolean isAnonymous() {
      return isAnonymous;
   }

   public AspectModelFile getSourceFile() {
      return sourceFile;
   }

   public static Builder builder() {
      return new Builder();
   }

   @Override
   public boolean equals( final Object o ) {
      if ( this == o ) {
         return true;
      }
      if ( o == null || getClass() != o.getClass() ) {
         return false;
      }
      final MetaModelBaseAttributes that = (MetaModelBaseAttributes) o;
      return isAnonymous == that.isAnonymous && Objects.equals( urn, that.urn ) && Objects.equals( preferredNames,
            that.preferredNames ) && Objects.equals( descriptions, that.descriptions ) && Objects.equals( see, that.see );
   }

   @Override
   public int hashCode() {
      return Objects.hash( urn, preferredNames, descriptions, see, isAnonymous );
   }

   /**
    * Creates an instance of MetaModelBaseAttributes by copying them from a given element.
    *
    * @param modelElement the named model element to copy the base attributes from
    * @return the newly created instance
    */
   public static MetaModelBaseAttributes fromModelElement( final ModelElement modelElement ) {
      return new MetaModelBaseAttributes( modelElement.urn(), modelElement.getPreferredNames(),
            modelElement.getDescriptions(), modelElement.getSee(), modelElement.isAnonymous(), modelElement.getSourceFile() );
   }

   public static class Builder {
      private AspectModelUrn urn;
      private final Set preferredNames = new HashSet<>();
      private final Set descriptions = new HashSet<>();
      private final List see = new ArrayList<>();
      private boolean isAnonymous = true;
      private AspectModelFile sourceFile;

      public Builder withUrn( final String urn ) {
         return withUrn( AspectModelUrn.fromUrn( urn ) );
      }

      public Builder withOptionalUrn( final Optional aspectModelUrn ) {
         if ( aspectModelUrn.isPresent() ) {
            return withUrn( aspectModelUrn.get() );
         } else {
            return isAnonymous();
         }
      }

      public Builder withUrn( final AspectModelUrn urn ) {
         isAnonymous = false;
         this.urn = Objects.requireNonNull( urn );
         return this;
      }

      public Builder isAnonymous() {
         isAnonymous = true;
         return this;
      }

      public Builder withPreferredName( final Locale locale, final String preferredName ) {
         preferredNames.add( new LangString( preferredName, locale ) );
         return this;
      }

      public Builder withPreferredNames( final Set preferredNames ) {
         this.preferredNames.addAll( preferredNames );
         return this;
      }

      public Builder withDescription( final Locale locale, final String description ) {
         descriptions.add( new LangString( description, locale ) );
         return this;
      }

      public Builder withDescriptions( final Set descriptions ) {
         this.descriptions.addAll( descriptions );
         return this;
      }

      public Builder withSee( final String see ) {
         this.see.add( see );
         return this;
      }

      public Builder withSee( final List see ) {
         this.see.addAll( see );
         return this;
      }

      public Builder withSourceFile( final AspectModelFile sourceFile ) {
         this.sourceFile = sourceFile;
         return this;
      }

      public Builder isAnonymous( final boolean isAnonymous ) {
         this.isAnonymous = isAnonymous;
         return this;
      }

      public MetaModelBaseAttributes build() {
         return new MetaModelBaseAttributes( urn, preferredNames, descriptions, see, isAnonymous, sourceFile );
      }
   }
}