Package com.iizix.prop

Class PWAProps

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.PWAProps
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable
Direct Known Subclasses:
EditorPWAProps
public class PWAProps extends PropCnr
The Progressive Web App (PWA) properties.
Author:
Christopher Mindus

  • Field Details

    • FILE_NAME

      public static final String FILE_NAME
      The file name of the PWA properties container: ".iiziPWA".
      See Also:

    • ATOM

      public static final Atom ATOM
      The atom for the PWA properties container: "$pwa".

    • LOCALIZED_LANGUAGES_PROPNAME

      public static final String LOCALIZED_LANGUAGES_PROPNAME
      The property name for the localized languages String: "localized".
      See Also:

    • APP_NAME_PROPNAME

      public static final String APP_NAME_PROPNAME
      The property name for the application name PlainKString: "name".
      See Also:

    • APP_DESCR_ATOM

      public static final Atom APP_DESCR_ATOM
      The property atom for the application description PlainKString: Atom.DESCR.

    • SCRIPT_TAG

      public static final String SCRIPT_TAG
      The property name for the Firebase "<script>" tag HTML string.
      See Also:

    • UNKNOWN

      public static final String UNKNOWN
      The String "UNKNOWN".
      See Also:

  • Constructor Details

    • PWAProps

      public PWAProps()
      Creates a PWAProps container without name and with a null value.

    • PWAProps

      public PWAProps(Atom propertyAtom)
      Creates a PWAProps container with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

  • Method Details

    • onEventSelf

      public void onEventSelf(GEvent event)
      Overridden to check for cache clearing of FirebaseConfig object.
      Specified by:
      onEventSelf in interface IGProp<GProp<?>[]>
      Overrides:
      onEventSelf in class GProp<GProp<?>[]>
      Parameters:
      event - The event sent to this container.

    • clone

      public PWAProps clone()
      Creates a clone out of this property.
      Overrides:
      clone in class PropCnr
      Returns:
      The clone of the PWAProps.

    • getLocalizedLanguages

      public String getLocalizedLanguages()
      Gets the list of localized languages.
      Returns:
      A comma separated list of language codes, null if undefined.

    • getName

      public PlainKString getName()
      Gets the name of the app.
      Returns:
      The name of the app can be localized, or null if not defined.

    • getDescription

      public PlainKString getDescription()
      Gets the description of the app.
      Returns:
      The description of the app can be localized, or null if not defined.

    • getScriptTag

      public String getScriptTag()
      Gets the Firebase "<script>" tag HTML string.
      Returns:
      The String, or null for error.

    • getFirebaseConfigScriptTag

      public PWAProps.FirebaseScriptTag getFirebaseConfigScriptTag()
      Gets the cached and parsed FirebaseConfig script tag for the app.
      Returns:
      The cached and parsed FirebaseConfig script tag of the app.
      Throws:
      IllegalArgumentException - In case of failure.

    • verify

      public boolean verify(PropVerification verification)
      Verifies this property container. The check performed is the extension of classes and that no circular reference is present.
      Specified by:
      verify in interface IGProp<GProp<?>[]>
      Overrides:
      verify in class PropCnr
      Parameters:
      verification - The property verification class.
      Returns:
      true if verification should proceed, false if disposed of and verification should not take place.