Package org.smooks.api.profile

Interface ProfileSet

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    DefaultProfileSet
    public interface ProfileSet
extends Serializable
    Profile Set.

    A profile set consists of a "base" profile and a set of sub-profiles. The base profile fans out into a set of sub profiles.

    Author:
    tfennelly

    • Method Detail

      • getBaseProfile

        String getBaseProfile()
        Get the name of the base profile for this profile set.
        Returns:
        The base profile name.

      • isMember

        boolean isMember​(String profile)
        Is the specified profile a member of this profile set.

        A profile is said to be a member of a profile set if it is the base profile of the profile set, or one of its sub profiles.

        Parameters:
        profile - The profile to check against.
        Returns:
        True if the associated device a member of the specified profile, otherwise false.

      • addProfile

        void addProfile​(Profile profile)
        Add a profile to the ProfileSet.
        Parameters:
        profile - The profile to add.

      • getProfile

        Profile getProfile​(String profile)
        Get a profile from the ProfileSet.
        Parameters:
        profile - The name of the profile.
        Returns:
        The requested Profile, or null if the profile is not a member of the ProfileSet.