/** * @return the list of allowed parent for this entity type * @since 10.6RC1 */ @Unstable public List<EntityType> getAllowedParents() { return this.allowedParents; }
/** * @param pageName the name of the document * @param parent the parent space for the document * @param parameters parameters for this reference, may be null * @since 10.6RC1 */ @Unstable public DocumentReference(String pageName, EntityReference parent, Map<String, Serializable> parameters) { super(pageName, EntityType.DOCUMENT, parent, parameters); }
/** * Right now the security module logic only works with DOCUMENT based reference so PAGE reference need to be * converted. * * @param reference the reference * @return the compatible reference * @since 10.6RC1 */ @Unstable EntityReference toCompatibleEntityReference(EntityReference reference); }
/** * * @version $Id: 20e88757d1241998b5c93b85c157d925bc86331d $ * @since 5.2M2 */ @Unstable public interface FileInputSource extends InputSource { public File getFile(); }
/** * @version $Id: f92d024b15e8d1da35992e518fa65a34b1af7b69 $ * @since 5.2 */ @Unstable public interface BeanInputWikiStreamFactory<P> extends InputWikiStreamFactory { BeanInputWikiStream<P> createInputWikiStream(P properties) throws WikiStreamException; }
/** * * @version $Id: 2ea466448101807dd612e06382ba78696938c3d9 $ * @since 5.2M2 */ @Unstable public interface ReaderInputSource extends InputSource { public Reader getReader(); }
/** * * @version $Id: 351cf08e63e8ef12cf58ebe25a253ed1ab61eb77 $ * @since 5.2M2 */ @Unstable public interface URLInputSource extends InputSource { public URL getURL(); }
/** * Creates and returns a new empty entity, setting the given principal as the creator. * * @param creator a reference to the document representing a principal (a user or a group) which will be set as the * creator for the created entity * @return the created entity, or {@code null} in case of errors */ @Unstable("The type of the parameter will be replaced by Principal, once the principals module is implemented") E create(DocumentReference creator);
/** * @return the user agent to use when sending pings to the remote server * @since 1.1 */ @Unstable String getUserAgent(); }
/** * @return the author of the current document. * @since 10.10RC1 * @since 10.8.2 * @since 9.11.9 */ @Unstable default DocumentReference getCurrentAuthorReference() { return null; } }
/** * @return true if the macro can be inserted in some existing content such as a paragraph, a list item etc. For * example if I have <code>== hello {{velocity}}world{{/velocity}}</code> then the Velocity macro must * support the inline mode and not generate a paragraph. * @since 10.10RC1 */ @Unstable default boolean supportsInlineMode() { return false; } }
/** * This method will return the type of the macro content. By default it fallback to String. * * @return the type of the macro content. * @since 10.10RC1 */ @Unstable default Type getType() { return String.class; } }
/** * The custom predefined phenotypes displayed in the "Clinical Symptoms" section are configured in a document, and * this type of configuration is called a "Phenotype Mapping". Multiple such mappings can exist in a PhenoTips * instance, and one of these mappings can be selected as the preferred mapping to be used globally or for each * group. Warning! The return type of this method is likely to change once a more specific class for representing * mappings will be implemented. * * @return the selected phenotype mapping, as a reference to the document where the mapping is defined */ @Unstable DocumentReference getPhenotypeMapping();
/** * @version $Id: 13f027e188e007fb0074df28f14ae640a51956e3 $ * @since 5.2M2 */ @Unstable public interface OutputWikiStream extends Closeable { Object getFilter() throws WikiStreamException; }
/** * @version $Id: a91ba438a77de8922160c23314cc04e4f5e51a98 $ * @since 5.2M2 */ @Unstable public interface InputWikiStream extends Closeable { void read(Object filter) throws WikiStreamException; }
/** * Marker interface for asymmetric cipher parameters. * * @version $Id: 46132277c589eabef0b0bae4e3469293e66b1e2f $ * @since 5.4M1 */ @Unstable public interface AsymmetricCipherParameters extends CipherParameters { }
/** * @param type the type * @return true of the passed type is a possible ancestor of the passed type * @since 10.6RC1 */ @Unstable public boolean isAllowedAncestor(EntityType type) { return this.allowedAncestors[type.ordinal()]; } }
/** * @param parameters the macro parameters in the form of a bean defined by the {@link Macro} implementation * @param content the content of the macro * @param context the context of the macros transformation process * @return the title represented as a list of Blocks * @since 10.10 */ @Unstable protected List<? extends Block> getBlockTitle(P parameters, String content, MacroTransformationContext context) { return parameters.getBlockTitle(); }
/** * @param parameters the macro parameters in the form of a bean defined by the {@link Macro} implementation * @param content the content of the macro * @param context the context of the macros transformation process * @return the title of the box * @since 10.10 */ @Unstable protected String getTitle(P parameters, String content, MacroTransformationContext context) { return parameters.getTitle(); }
/** * Clone an EntityReference, but use the specified paramaters. * * @param reference the reference to clone * @param parameters parameters for this reference, may be null * @since 10.6RC1 */ @Unstable public EntityReference(EntityReference reference, Map<String, Serializable> parameters) { this(reference.getName(), reference.getType(), reference.getParent(), parameters); }