Package com.tagtraum.beatunes.inspection

Class CapitalizationInspector.DifferentLanguageInputDialogSolution

  • All Implemented Interfaces:
    Solution<com.tagtraum.beatunes.inspection.CapitalizationInspector.CapitalizationIssue>
    Enclosing class:
    CapitalizationInspector
    public static class CapitalizationInspector.DifferentLanguageInputDialogSolution
extends Object

    • Constructor Detail

      • DifferentLanguageInputDialogSolution

        public DifferentLanguageInputDialogSolution​(com.tagtraum.beatunes.inspection.CapitalizationInspector.CapitalizationIssue issue)

    • Method Detail

      • createCallable

        public CallableSolution createCallable​(Collection<AudioSong> songs,
                                       boolean allowUserInteraction)
        Description copied from interface: Solution

        Creates a CallableSolution that may be called later to actually apply this solution. You may return null to signal, that the callable could not be created, perhaps because the user cancelled some interaction.

        This method is typically called on the EDT to allow potential user interaction, so it must execute quickly.

        Specified by:
        createCallable in interface Solution<com.tagtraum.beatunes.inspection.CapitalizationInspector.CapitalizationIssue>
        Parameters:
        songs - songs this solution should be applied to, i.e. the songs the user selected in the UI
        allowUserInteraction - if set to true the solution may show a dialog asking for confirmation or some other form of visual user interaction. If set to false, the solution has to be applied silently.
        Returns:
        a callable, if the problem can be solved, null, if the user cancelled or some other problem occurred

      • getDescription

        public String getDescription()
        Description copied from interface: Solution
        Description of this solution. You may use HTML, but no enclosing <html> tags. E.g.: 
        My <em>super</em> solution.
        Specified by:
        getDescription in interface Solution<com.tagtraum.beatunes.inspection.CapitalizationInspector.CapitalizationIssue>
        Returns:
        description
        See Also:
        Solution.getClassDescription()

      • getClassDescription

        public String getClassDescription()
        Description copied from interface: Solution
        Returns a common description for this class of solution. This is used when the same kind (or class) of solution should be used for a collection of issues. In other words, the user selects multiple issues and wants them all solved in the same way. This implies, that there cannot be any user interaction.
        If this solution does not make any sense as a class solution, this method must return null.
        Specified by:
        getClassDescription in interface Solution<com.tagtraum.beatunes.inspection.CapitalizationInspector.CapitalizationIssue>
        Returns:
        description contains description for a whole collection of issues, not an individual one or null, if this solution cannot be applied to multiple issues at once (because it is too specific for a given issue)
        See Also:
        Solution.getDescription(), Solution.getClassId()

      • getClassId

        public String getClassId()
        Description copied from interface: Solution
        Id for a class of solutions. If this solutions cannot be applied for multiple issues at once, this method must return null.
        Specified by:
        getClassId in interface Solution<com.tagtraum.beatunes.inspection.CapitalizationInspector.CapitalizationIssue>
        Returns:
        id for this solution's class - typically unique per solutions class. Default value (if used) should be the actual class name, i.e. solution.getClass().getName()
        See Also:
        Solution.getClassDescription()