org.owasp.validator.html.model.Property Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of antisamy Show documentation
A library for performing fast, configurable cleansing of HTML coming from untrusted sources.
The newest version!
/*
 * Copyright (c) 2007-2022, Arshan Dabirsiaghi, Jason Li
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * 	 this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of OWASP nor the names of its contributors may be used to
 *   endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.owasp.validator.html.model;

import java.util.Collections;
import java.util.List;
import java.util.regex.Pattern;

/**
 * A model for CSS properties and the "rules" they must follow (either literals or regular
 * expressions) in order to be considered valid.
 *
 * @author Jason Li
 */
public class Property {
  private final String name;

  private final List allowedRegExp;

  private final List allowedValues;

  private final List shorthandRefs;

  public Property(
      String name,
      List allowedRegexp3,
      List allowedValue,
      List shortHandRefs,
      String description,
      String onInvalidStr) {
    this.name = name;
    this.allowedRegExp = Collections.unmodifiableList(allowedRegexp3);
    this.allowedValues = Collections.unmodifiableList(allowedValue);
    this.shorthandRefs = Collections.unmodifiableList(shortHandRefs);
  }

  /**
   * Return a List of allowed regular expressions
   *
   * @return The List of allowed regular expressions.
   */
  public List getAllowedRegExp() {
    return allowedRegExp;
  }

  /**
   * Return a List of allowed literal values
   *
   * @return The List of allowed literal values.
   */
  public List getAllowedValues() {
    return allowedValues;
  }

  /**
   * Return a List of allowed shorthand references
   *
   * @return The List of allowed shorthand references.
   */
  public List getShorthandRefs() {
    return shorthandRefs;
  }

  /**
   * Get the name of the property.
   *
   * @return The name of the property.
   */
  public String getName() {
    return name;
  }
}