net.sourceforge.pmd.properties.PropertySerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pmd-core Show documentation

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned with Java and Apex, but supports 16 other languages. It comes with 400+ built-in rules. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query. Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce, Kotlin, Swift, Modelica, PLSQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL. Scala is supported, but there are currently no Scala rules available. Additionally, it includes CPD, the copy-paste-detector. CPD finds duplicated code in Coco, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex and Visualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

There is a newer version: 7.5.0-metrics

Show newest version

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.properties;

import java.util.Collections;
import java.util.List;

import org.checkerframework.checker.nullness.qual.NonNull;


/**
 * Strategy to serialize a value to and from strings.
 */
public abstract class PropertySerializer {

    PropertySerializer() {
        // package private, we want to control available mappers to
        // put them into the ruleset schema
    }


    /**
     * Returns the constraints that this mapper applies to values
     * after parsing them. This may be used for documentation, or
     * to check a constraint on a value that was not parsed from
     * XML.
     *
     * @implNote See {@link ConstraintDecorator}
     */
    public abstract List> getConstraints();

    /**
     * Returns a new XML mapper that will check parsed values with
     * the given constraint.
     */
    public PropertySerializer withConstraint(PropertyConstraint t) {
        return new ConstraintDecorator<>(this, Collections.singletonList(t));
    }

    /**
     * Read the value from a string, if it is supported.
     *
     * @throws IllegalArgumentException      if something goes wrong (but should be reported on the error reporter)
     */
    public abstract T fromString(@NonNull String attributeData);

    /**
     * Format the value to a string.
     *
     * @throws IllegalArgumentException      if something goes wrong (but should be reported on the error reporter)
     */
    public abstract @NonNull String toString(T value);


}