com.phloc.css.decl.IHasCSSDeclarations 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.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.state.EChange;
import com.phloc.css.ICSSWriteable;
/**
* Sanity interface for all objects having CSS declarations.
*
* @author Philip Helger
*/
public interface IHasCSSDeclarations extends ICSSWriteable
{
/**
* Add a new declaration.
*
* @param aDeclaration
* The declaration to be added. May not be null.
* @return this
*/
@Nonnull
IHasCSSDeclarations addDeclaration (@Nonnull CSSDeclaration aDeclaration);
/**
* Add a new declaration.
*
* @param sProperty
* The name of the property. E.g. "color". May neither be
* null nor empty.
* @param aExpression
* The value of the property. May not be null.
* @param bImportant
* true if it is important, false if not.
* @return this
*/
@Nonnull
IHasCSSDeclarations addDeclaration (@Nonnull @Nonempty final String sProperty,
@Nonnull final CSSExpression aExpression,
final boolean bImportant);
/**
* Add a new declaration at the specified index.
*
* @param nIndex
* The index to retrieve. Must be ≥ 0. If the index is ≥ than
* getDeclarationCount(), it behaves like
* {@link #addDeclaration(CSSDeclaration)}.
* @param aDeclaration
* The declaration to be added. May not be null.
* @return this
*/
@Nonnull
IHasCSSDeclarations addDeclaration (@Nonnegative int nIndex, @Nonnull CSSDeclaration aDeclaration);
/**
* Remove the given declaration
*
* @param aDeclaration
* The declaration to be removed. May not be null.
* @return {@link EChange#CHANGED} if the declaration was successfully removed
*/
@Nonnull
EChange removeDeclaration (@Nonnull CSSDeclaration aDeclaration);
/**
* Remove the declaration at the specified index
*
* @param nDeclarationIndex
* The index of the declaration to be removed. Must be ≥ 0.
* @return {@link EChange#CHANGED} if the declaration was successfully
* removed, {@link EChange#UNCHANGED} if the index was invalid.
*/
@Nonnull
EChange removeDeclaration (@Nonnegative int nDeclarationIndex);
/**
* Remove all declarations.
*
* @return {@link EChange#CHANGED} if any declaration was removed,
* {@link EChange#UNCHANGED} otherwise. Never null.
* @since 3.7.3
*/
@Nonnull
EChange removeAllDeclarations ();
/**
* @return A mutable, non-null copy of all contained
* declarations.
*/
@Nonnull
@ReturnsMutableCopy
List getAllDeclarations ();
/**
* @param nIndex
* The index to retrieve
* @return The declaration at the specified index or null if the
* index is invalid
*/
@Nullable
CSSDeclaration getDeclarationAtIndex (@Nonnegative int nIndex);
/**
* Set the declaration at the specified index with a new one. If an existing
* declaration is present at that index, it is overwritten.
*
* @param nIndex
* The index to retrieve. Must be ≥ 0. If the index is ≥ than
* getDeclarationCount(), it behaves like
* {@link #addDeclaration(CSSDeclaration)}.
* @param aNewDeclaration
* The new declaration to be set.
* @return this
*/
@Nonnull
IHasCSSDeclarations setDeclarationAtIndex (@Nonnegative int nIndex, @Nonnull CSSDeclaration aNewDeclaration);
/**
* @return true if at least one declaration is present,
* false if no declaration is present.
*/
boolean hasDeclarations ();
/**
* @return The number of contained declarations. Always ≥ 0.
*/
@Nonnegative
int getDeclarationCount ();
/**
* Get the first declaration with the specified property name. If no such
* property name is present, null is returned. If more than one
* declaration ith the specified property name is present, always the first in
* the list will be returned. The comparison happens case sensitive.
*
* @param sPropertyName
* The property name of the declaration to search (e.g.
* color). May be null.
* @return null if no such property name was found.
* @since 3.7.4
*/
@Nullable
CSSDeclaration getDeclarationOfPropertyName (@Nullable String sPropertyName);
/**
* Get the first declaration with the specified property name. If no such
* property name is present, null is returned. If more than one
* declaration ith the specified property name is present, always the first in
* the list will be returned. The comparison happens case insensitive.
*
* @param sPropertyName
* The property name of the declaration to search (e.g.
* color). May be null.
* @return null if no such property name was found.
* @since 3.7.4
*/
@Nullable
CSSDeclaration getDeclarationOfPropertyNameCaseInsensitive (@Nullable String sPropertyName);
/**
* Get all declarations within this list that have the specified property
* name. The comparison happens case sensitive.
*
* @param sPropertyName
* The property name of the declaration to search (e.g.
* color). May be null.
* @return Never null but maybe an empty list.
* @since 3.7.4
*/
@Nonnull
@ReturnsMutableCopy
List getAllDeclarationsOfPropertyName (@Nullable String sPropertyName);
/**
* Get all declarations within this list that have the specified property
* name. The comparison happens case insensitive.
*
* @param sPropertyName
* The property name of the declaration to search (e.g.
* color). May be null.
* @return Never null but maybe an empty list.
* @since 3.7.4
*/
@Nonnull
@ReturnsMutableCopy
List getAllDeclarationsOfPropertyNameCaseInsensitive (@Nullable String sPropertyName);
}