io.wcm.qa.galenium.differences.base.DifferenceBase Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2017 wcm.io
 * %%
 * 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
 *
 *      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 License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package io.wcm.qa.galenium.differences.base;

import org.apache.commons.lang3.StringUtils;

import io.wcm.qa.galenium.format.NameUtil;

/**
 * Basic functionality needed by most {@link Difference} implementations.
 */
public abstract class DifferenceBase implements Difference {

  private static final int MAX_TAG_LENGTH = 20;
  private static final String CLASS_NAME_PART_DIFFERENCE = "difference";
  private String name;

  @Override
  public String getName() {
    if (StringUtils.isBlank(name)) {
      String simpleName = getClass().getSimpleName();
      simpleName = StringUtils.removeStartIgnoreCase(simpleName, CLASS_NAME_PART_DIFFERENCE);
      simpleName = StringUtils.removeEndIgnoreCase(simpleName, CLASS_NAME_PART_DIFFERENCE);
      return simpleName;
    }
    return name;
  }

  @Override
  public String getTag() {
    return NameUtil.getSanitized(getRawTag(), MAX_TAG_LENGTH);
  }

  protected abstract String getRawTag();

  public void setName(String name) {
    this.name = name;
  }

  @Override
  public String toString() {
    return getName() + ": '" + getTag() + "'";
  }

}