Interface IFolder


public interface IFolder
Since:
3.8.3
  • Method Details

    • getName

      @NotNull String getName()
    • getTitle

      @Nullable String getTitle()
    • getTitleOrName

      @NotNull String getTitleOrName()
      Returns the full path of this folder in a "Parent folder name / current folder name" format or only the current folder name if there is no parent folder. If the folders have titles, the titles are used instead of the names.
    • getTitleOrName

      @NotNull String getTitleOrName(@NotNull String separator)
      Returns the full path of this folder in a "Parent folder name {SEPERATOR} current folder name" format or only the current folder name if there is no parent folder. If the folders have titles, the titles are used instead of the names.
      Since:
      3.22.2
    • getProject

      @Nullable IProject getProject()
    • getChildFolders

      @NotNull List<IFolder> getChildFolders()
      Returns a list of IFolder contained in this folder.
      Since:
      3.18.1
    • getParent

      @Nullable IFolder getParent()
      Returns parent IFolder. Returns null for the root folder.
      Since:
      3.18.1
    • searchFolder

      @Nullable IFolder searchFolder(@NotNull String name)
      Search deeply contained folders by folder name.
      Since:
      3.18.1
    • createSubFolder

      @NotNull IFolder createSubFolder(@NotNull String name, @Nullable String title)
      Creates a new sub folder in this folder.
      Parameters:
      name - (ID) must be unique for the whole folder hierarchy.
      Returns:
      Just created IFolder.
      Since:
      3.18.1
    • can

      @NotNull ISpacePermissions can()
      Since:
      3.23.10
    • getContextId

      @Nullable IContextId getContextId()
      Since:
      3.23.10
    • getAuthor

      @Nullable IUser getAuthor()
      Since:
      3.23.10