com.helger.commons.format.FormatterStringSkipPrefixAndSuffix Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Show all versions of ph-commons Show documentation
Java 1.8+ Library with tons of utility classes required in all projects
The newest version!
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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.
*/
package com.helger.commons.format;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
/**
* A formatter that skip a prefix and/or a suffix to a string.
*
* @author Philip Helger
*/
public class FormatterStringSkipPrefixAndSuffix extends AbstractFormatterString
{
private final String m_sPrefix;
private final String m_sSuffix;
public FormatterStringSkipPrefixAndSuffix (@Nonnull final String sPrefix, @Nonnull final String sSuffix)
{
m_sPrefix = ValueEnforcer.notNull (sPrefix, "Prefix");
m_sSuffix = ValueEnforcer.notNull (sSuffix, "Suffix");
}
@Nonnull
public String getPrefix ()
{
return m_sPrefix;
}
@Nonnull
public String getSuffix ()
{
return m_sSuffix;
}
@Override
public String apply (@Nullable final Object aValue)
{
String sValue = getValueAsString (aValue);
// strip prefix and suffix
if (m_sPrefix.length () > 0)
sValue = StringHelper.trimStart (sValue, m_sPrefix);
if (m_sSuffix.length () > 0)
sValue = StringHelper.trimEnd (sValue, m_sSuffix);
return sValue;
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (o == null || !getClass ().equals (o.getClass ()))
return false;
final FormatterStringSkipPrefixAndSuffix rhs = (FormatterStringSkipPrefixAndSuffix) o;
return m_sPrefix.equals (rhs.m_sPrefix) && m_sSuffix.equals (rhs.m_sSuffix);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_sPrefix).append (m_sSuffix).getHashCode ();
}
@Override
public String toString ()
{
return ToStringGenerator.getDerived (super.toString ()).append ("Prefix", m_sPrefix).append ("Suffix", m_sSuffix).getToString ();
}
@Nonnull
public static FormatterStringSkipPrefixAndSuffix createPrefixOnly (@Nonnull final String sPrefix)
{
return new FormatterStringSkipPrefixAndSuffix (sPrefix, "");
}
@Nonnull
public static FormatterStringSkipPrefixAndSuffix createSuffixOnly (@Nonnull final String sSuffix)
{
return new FormatterStringSkipPrefixAndSuffix ("", sSuffix);
}
}