CqlPart.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.cyclop.model;

import java.io.Serializable;

import net.jcip.annotations.Immutable;

import org.apache.commons.lang.StringEscapeUtils;
import org.hibernate.validator.constraints.NotEmpty;

import com.google.common.base.MoreObjects;

/** @author Maciej Miklas */
@Immutable
@SuppressWarnings("EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS")
public class CqlPart implements Comparable<CqlPart>, Serializable, DisplaySupport {

	@NotEmpty
	public final String partLc;

	@NotEmpty
	public final String part;

	public CqlPart(String part) {
		if (part != null) {
			this.part = part.replaceAll("\\p{Cc}", "");
			this.partLc = this.part.trim().toLowerCase();
		} else {
			this.part = null;
			this.partLc = null;
		}
	}

	@Override
	public int compareTo(CqlPart o) {
		return o.partLc.compareTo(partLc);
	}

	@edu.umd.cs.findbugs.annotations.SuppressWarnings("EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS")
	@Override
	public boolean equals(Object obj) {
		if (obj == null || getClass() != obj.getClass()) {
			return false;
		}
		CqlPart cqlObj = (CqlPart) obj;
		return java.util.Objects.equals(partLc, cqlObj.partLc);
	}

	@Override
	public int hashCode() {
		return partLc.hashCode();
	}

	public String toDisplayString() {
		return StringEscapeUtils.escapeHtml(part);
	}

	@Override
	public String toString() {
		return MoreObjects.toStringHelper(this).add("partLc", partLc).add("part", part).toString();
	}

	public CqlType type() {
		return CqlType.PART;
	}
}