com.phloc.css.decl.CSSMediaRule 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
/**
* 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.StringHelper;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.css.CSSSourceLocation;
import com.phloc.css.ICSSSourceLocationAware;
import com.phloc.css.ICSSWriterSettings;
/**
* Represents a single @media rule: a list of style rules only
* valid for certain media.
* Example:
* @media print {
div#footer {
display: none;
}
}
*
* @author Philip Helger
*/
@NotThreadSafe
public class CSSMediaRule implements ICSSTopLevelRule, ICSSSourceLocationAware
{
private final List m_aMediaQueries = new ArrayList ();
private final List m_aRules = new ArrayList ();
private CSSSourceLocation m_aSourceLocation;
public CSSMediaRule ()
{}
public boolean hasMediaQueries ()
{
return !m_aMediaQueries.isEmpty ();
}
@Nonnegative
public int getMediaQueryCount ()
{
return m_aMediaQueries.size ();
}
@Nonnull
public CSSMediaRule addMediaQuery (@Nonnull @Nonempty final CSSMediaQuery aMediaQuery)
{
ValueEnforcer.notNull (aMediaQuery, "MediaQuery");
m_aMediaQueries.add (aMediaQuery);
return this;
}
@Nonnull
public CSSMediaRule addMediaQuery (@Nonnegative final int nIndex, @Nonnull @Nonempty 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;
}
@Nonnull
public EChange removeMediaQuery (@Nonnull final CSSMediaQuery aMediaQuery)
{
return EChange.valueOf (m_aMediaQueries.remove (aMediaQuery));
}
@Nonnull
public EChange removeMediaQuery (@Nonnegative final int nMediumIndex)
{
if (nMediumIndex < 0 || nMediumIndex >= m_aMediaQueries.size ())
return EChange.UNCHANGED;
m_aMediaQueries.remove (nMediumIndex);
return EChange.CHANGED;
}
/**
* Remove all media queries.
*
* @return {@link EChange#CHANGED} if any media query was removed,
* {@link EChange#UNCHANGED} otherwise. Never null.
* @since 3.7.3
*/
@Nonnull
public EChange removeAllMediaQueries ()
{
if (m_aMediaQueries.isEmpty ())
return EChange.UNCHANGED;
m_aMediaQueries.clear ();
return EChange.CHANGED;
}
@Nullable
public CSSMediaQuery getMediaQueryAtIndex (@Nonnegative final int nMediumIndex)
{
if (nMediumIndex < 0 || nMediumIndex >= m_aMediaQueries.size ())
return null;
return m_aMediaQueries.get (nMediumIndex);
}
@Nonnull
@ReturnsMutableCopy
public List getAllMediaQueries ()
{
return ContainerHelper.newList (m_aMediaQueries);
}
public boolean hasRules ()
{
return !m_aRules.isEmpty ();
}
@Nonnegative
public int getRuleCount ()
{
return m_aRules.size ();
}
@Nonnull
public CSSMediaRule addRule (@Nonnull final ICSSTopLevelRule aRule)
{
ValueEnforcer.notNull (aRule, "Rule");
m_aRules.add (aRule);
return this;
}
@Nonnull
public CSSMediaRule addRule (@Nonnegative final int nIndex, @Nonnull final ICSSTopLevelRule aRule)
{
ValueEnforcer.isGE0 (nIndex, "Index");
ValueEnforcer.notNull (aRule, "Rule");
if (nIndex >= getRuleCount ())
m_aRules.add (aRule);
else
m_aRules.add (nIndex, aRule);
return this;
}
@Nonnull
public EChange removeRule (@Nonnull final ICSSTopLevelRule aRule)
{
return EChange.valueOf (m_aRules.remove (aRule));
}
@Nonnull
public EChange removeRule (@Nonnegative final int nRuleIndex)
{
if (nRuleIndex < 0 || nRuleIndex >= m_aRules.size ())
return EChange.UNCHANGED;
m_aRules.remove (nRuleIndex);
return EChange.CHANGED;
}
/**
* Remove all rules.
*
* @return {@link EChange#CHANGED} if any rule was removed,
* {@link EChange#UNCHANGED} otherwise. Never null.
* @since 3.7.3
*/
@Nonnull
public EChange removeAllRules ()
{
if (m_aRules.isEmpty ())
return EChange.UNCHANGED;
m_aRules.clear ();
return EChange.CHANGED;
}
@Nullable
public ICSSTopLevelRule getRule (@Nonnegative final int nRuleIndex)
{
if (nRuleIndex < 0 || nRuleIndex >= m_aRules.size ())
return null;
return m_aRules.get (nRuleIndex);
}
@Nonnull
@ReturnsMutableCopy
public List getAllRules ()
{
return ContainerHelper.newList (m_aRules);
}
@Nonnull
@Nonempty
public String getAsCSSString (@Nonnull final ICSSWriterSettings aSettings, @Nonnegative final int nIndentLevel)
{
// Always ignore media rules?
if (!aSettings.isWriteMediaRules ())
return "";
final boolean bOptimizedOutput = aSettings.isOptimizedOutput ();
final int nRuleCount = m_aRules.size ();
if (aSettings.isRemoveUnnecessaryCode () && nRuleCount == 0)
return "";
final StringBuilder aSB = new StringBuilder ("@media ");
boolean bFirst = true;
for (final CSSMediaQuery sMedium : m_aMediaQueries)
{
if (bFirst)
bFirst = false;
else
aSB.append (bOptimizedOutput ? "," : ", ");
aSB.append (sMedium.getAsCSSString (aSettings, nIndentLevel));
}
if (nRuleCount == 0)
{
aSB.append (bOptimizedOutput ? "{}" : " {}\n");
}
else
{
// At least one rule present
aSB.append (bOptimizedOutput ? "{" : " {\n");
bFirst = true;
for (final ICSSTopLevelRule aRule : m_aRules)
{
final String sRuleCSS = aRule.getAsCSSString (aSettings, nIndentLevel + 1);
if (StringHelper.hasText (sRuleCSS))
{
if (bFirst)
bFirst = false;
else
if (!bOptimizedOutput)
aSB.append ('\n');
if (!bOptimizedOutput)
aSB.append (aSettings.getIndent (nIndentLevel + 1));
aSB.append (sRuleCSS);
}
}
if (!bOptimizedOutput)
aSB.append (aSettings.getIndent (nIndentLevel));
aSB.append ('}');
if (!bOptimizedOutput)
aSB.append ('\n');
}
return aSB.toString ();
}
/**
* Set the source location of the object, determined while parsing.
*
* @param aSourceLocation
* The source location to use. May be null.
*/
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 CSSMediaRule rhs = (CSSMediaRule) o;
return m_aMediaQueries.equals (rhs.m_aMediaQueries) && m_aRules.equals (rhs.m_aRules);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_aMediaQueries).append (m_aRules).getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("mediaQueries", m_aMediaQueries)
.append ("styleRules", m_aRules)
.appendIfNotNull ("sourceLocation", m_aSourceLocation)
.toString ();
}
}