com.phloc.css.decl.CSSImportRule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-css-jdk5 Show documentation
Show all versions of phloc-css-jdk5 Show documentation
phloc CSS parser an other components
The newest version!
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[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.phloc.css.decl;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.collections.ContainerHelper;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.state.EChange;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.css.CSSSourceLocation;
import com.phloc.css.ICSSSourceLocationAware;
import com.phloc.css.ICSSWriteable;
import com.phloc.css.ICSSWriterSettings;
/**
* Represents a single import rule on top level. It consists of a mandatory URI
* and an optional list of media queries.
* Example:
* @import url("style.css") screen;
*
* @author Philip Helger
*/
@NotThreadSafe
public class CSSImportRule implements ICSSWriteable, ICSSSourceLocationAware
{
private CSSURI m_aLocation;
private final List m_aMediaQueries = new ArrayList ();
private CSSSourceLocation m_aSourceLocation;
public CSSImportRule (@Nonnull @Nonempty final String sLocation)
{
this (new CSSURI (sLocation));
}
public CSSImportRule (@Nonnull final CSSURI aLocation)
{
setLocation (aLocation);
}
/**
* @return true if this import rule has any specific media
* queries, to which it belongs, false if not.
*/
public boolean hasMediaQueries ()
{
return !m_aMediaQueries.isEmpty ();
}
/**
* @return The number of contained media queries. Always ≥ 0.
*/
@Nonnegative
public int getMediaQueryCount ()
{
return m_aMediaQueries.size ();
}
/**
* Add a media query at the end of the list.
*
* @param aMediaQuery
* The media query to be added. May not be null.
* @return this
*/
@Nonnull
public CSSImportRule addMediaQuery (@Nonnull final CSSMediaQuery aMediaQuery)
{
ValueEnforcer.notNull (aMediaQuery, "MediaQuery");
m_aMediaQueries.add (aMediaQuery);
return this;
}
/**
* Add a media query at the specified index of the list.
*
* @param nIndex
* The index where to add the media query. Must be ≥ 0.
* @param aMediaQuery
* The media query to be added. May not be null.
* @return this
*/
@Nonnull
public CSSImportRule addMediaQuery (@Nonnegative final int nIndex, @Nonnull final CSSMediaQuery aMediaQuery)
{
ValueEnforcer.isGE0 (nIndex, "Index");
ValueEnforcer.notNull (aMediaQuery, "MediaQuery");
if (nIndex >= getMediaQueryCount ())
m_aMediaQueries.add (aMediaQuery);
else
m_aMediaQueries.add (nIndex, aMediaQuery);
return this;
}
/**
* Remove the specified media query.
*
* @param aMediaQuery
* The media query to be removed. May be null.
* @return {@link EChange#CHANGED} if removal was successful.
*/
@Nonnull
public EChange removeMediaQuery (@Nullable final CSSMediaQuery aMediaQuery)
{
return EChange.valueOf (m_aMediaQueries.remove (aMediaQuery));
}
/**
* Remove the media query at the specified index.
*
* @param nMediumIndex
* The index of the media query to be removed.
* @return {@link EChange#CHANGED} if removal was successful.
*/
@Nonnull
public EChange removeMediaQuery (final int nMediumIndex)
{
if (nMediumIndex < 0 || nMediumIndex >= m_aMediaQueries.size ())
return EChange.UNCHANGED;
m_aMediaQueries.remove (nMediumIndex);
return EChange.CHANGED;
}
/**
* Remove all contained media queries.
*
* @return {@link EChange#CHANGED} if at least one media query was contained.
*/
@Nonnull
public EChange removeAllMediaQueries ()
{
if (m_aMediaQueries.isEmpty ())
return EChange.UNCHANGED;
m_aMediaQueries.clear ();
return EChange.CHANGED;
}
/**
* @return A list with all contained media queries. Never null
* and always a copy of the underlying list.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllMediaQueries ()
{
return ContainerHelper.newList (m_aMediaQueries);
}
/**
* @return The URL object of the CSS file to import. Never null.
*/
@Nonnull
public CSSURI getLocation ()
{
return m_aLocation;
}
/**
* @return The URL of the CSS file to import. Never null. This is
* a shortcut for getLocation().getURI()
*/
@Nonnull
@Nonempty
public String getLocationString ()
{
return m_aLocation.getURI ();
}
/**
* Set the URI of the file to be imported.
*
* @param aLocation
* The location to use. May not be null.
* @return this;
*/
@Nonnull
public CSSImportRule setLocation (@Nonnull final CSSURI aLocation)
{
ValueEnforcer.notNull (aLocation, "Location");
m_aLocation = aLocation;
return this;
}
/**
* Set the URI of the file to be imported.
*
* @param sLocationURI
* The location URI to use. May not be null.
* @return this;
*/
@Nonnull
public CSSImportRule setLocationString (@Nonnull @Nonempty final String sLocationURI)
{
m_aLocation.setURI (sLocationURI);
return this;
}
@Nonnull
@Nonempty
public String getAsCSSString (@Nonnull final ICSSWriterSettings aSettings, @Nonnegative final int nIndentLevel)
{
final boolean bOptimizedOutput = aSettings.isOptimizedOutput ();
final StringBuilder aSB = new StringBuilder ();
aSB.append ("@import ").append (m_aLocation.getAsCSSString (aSettings, nIndentLevel));
if (!m_aMediaQueries.isEmpty ())
{
aSB.append (' ');
boolean bFirst = true;
for (final CSSMediaQuery aMediaQuery : m_aMediaQueries)
{
if (bFirst)
bFirst = false;
else
aSB.append (bOptimizedOutput ? "," : ", ");
aSB.append (aMediaQuery.getAsCSSString (aSettings, nIndentLevel));
}
}
return aSB.append (";\n").toString ();
}
public void setSourceLocation (@Nullable final CSSSourceLocation aSourceLocation)
{
m_aSourceLocation = aSourceLocation;
}
@Nullable
public CSSSourceLocation getSourceLocation ()
{
return m_aSourceLocation;
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (o == null || !getClass ().equals (o.getClass ()))
return false;
final CSSImportRule rhs = (CSSImportRule) o;
return m_aLocation.equals (rhs.m_aLocation) && m_aMediaQueries.equals (rhs.m_aMediaQueries);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_aLocation).append (m_aMediaQueries).getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("location", m_aLocation)
.append ("mediaQueries", m_aMediaQueries)
.appendIfNotNull ("sourceLocation", m_aSourceLocation)
.toString ();
}
}