schemacrawler.loader.attributes.model.ObjectAttributes Maven / Gradle / Ivy

Go to download
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2025, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------

SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.

You may elect to redistribute this code under any of these licenses.

The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html

The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/

========================================================================
*/

package schemacrawler.loader.attributes.model;

import static java.util.Collections.emptyList;
import static java.util.Collections.emptyMap;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableMap;
import static java.util.Comparator.comparing;
import static java.util.Comparator.nullsLast;
import static java.util.Objects.compare;
import static us.fatehi.utility.Utility.isBlank;

import java.io.Serializable;
import java.util.Comparator;
import java.util.List;
import java.util.Map;

public abstract class ObjectAttributes implements Serializable, Comparable {

  private static final long serialVersionUID = -6819484903391182146L;

  private static Comparator comparator =
      nullsLast(comparing(ObjectAttributes::getName, String.CASE_INSENSITIVE_ORDER));

  private final String name;
  private final List remarks;
  private final Map attributes;

  public ObjectAttributes(
      final String name, final List remarks, final Map attributes) {

    if (isBlank(name)) {
      throw new IllegalArgumentException("No name provided");
    }
    this.name = name;

    if (remarks == null) {
      this.remarks = emptyList();
    } else {
      this.remarks = unmodifiableList(remarks);
    }
    if (attributes == null) {
      this.attributes = emptyMap();
    } else {
      this.attributes = unmodifiableMap(attributes);
    }
  }

  @Override
  public int compareTo(final ObjectAttributes o) {
    return compare(this, o, comparator);
  }

  public Map getAttributes() {
    return attributes;
  }

  public String getName() {
    return name;
  }

  public String getRemarks() {
    return String.join(System.lineSeparator(), remarks);
  }

  public boolean hasAttributes() {
    return !attributes.isEmpty();
  }

  public boolean hasRemarks() {
    if (remarks.isEmpty()) {
      return false;
    } else {
      return !isBlank(getRemarks());
    }
  }

  @Override
  public String toString() {
    return String.format("<%s>", getName());
  }
}