All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eu.mihosoft.vmf.runtime.core.Content Maven / Gradle / Ivy

/*
 * Copyright 2017-2024 Michael Hoffer . All rights reserved.
 * Copyright 2017-2019 Goethe Center for Scientific Computing, University Frankfurt. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * If you use this software for scientific research then please cite the following publication(s):
 *
 * M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
 * a framework for declarative GUI programming on the Java platform.
 * Computing and Visualization in Science, 2013, 16(4),
 * 181–192. http://doi.org/10.1007/s00791-014-0230-y
 */
package eu.mihosoft.vmf.runtime.core;

import eu.mihosoft.vcollections.VList;

import java.util.Iterator;
import java.util.stream.Stream;

/**
 * Content of this object graph. The content API of an object can be accessed via the {@code vmf()} method:
 * 
 * 

 * VObject o = ...
 * Content r = o.vmf().content()
 * 
* * @author Michael Hoffer ([email protected]) * @see {@link VMF} */ public interface Content { /** * Returns an iterator that traverses the object graph (depth first) * using the {@link VIterator.IterationStrategy#UNIQUE_PROPERTY} iteration strategy. * @return an iterator that traverses the object graph */ VIterator iterator(); /** * Returns an iterator that traverses the object graph (depth first) * using the specified iteration strategy. * @param strategy iteration strategy * @return an iterator that traverses the object graph */ VIterator iterator(VIterator.IterationStrategy strategy); /** * Returns a stream that contains all elements of the object graph (depth first) * using the {@link VIterator.IterationStrategy#UNIQUE_PROPERTY} iteration strategy. * @return a stream that contains all elements of the object graph */ Stream stream(); /** * Returns a stream that contains all elements of the object graph (depth first) * using the specified iteration strategy. * @param strategy iteration strategy * @return a stream that contains all elements of the object graph */ Stream stream(VIterator.IterationStrategy strategy); /** * Returns a stream that contains all elements of the object graph (depth first) that implement/extend the * specified type. It maps all elements to the specified type, i.e. returns {@code Stream}. * @param type type for filtering and mapping * @param element type * @return a stream of type , i.e. {@code Stream} */ Stream stream(Class type); /** * Returns a stream that contains all elements of the object graph (depth first) that implement/extend the * specified type. It maps all elements to the specified type, i.e. returns {@code Stream} using the specified * iteration strategy. * @param type type for filtering and mapping * @param strategy iteration strategy * @param element type * @return a stream of type , i.e. {@code Stream} */ Stream stream(Class type, VIterator.IterationStrategy strategy); /** * Returns an unmodifiable list of all objects that reference this object. * * @return an unmodifiable list of all objects that reference this object */ @Deprecated // TODO 17.02.2019 feature deactivated due to huge memory consumption VList referencedBy(); /** * Returns an unmodifiable list of all objects that are referenced by this object. * * @return an unmodifiable list of all objects that are referenced by this object. */ @Deprecated // TODO 17.02.2019 feature deactivated due to huge memory consumption VList references(); /** * Returns a deep copy of this object. * @return a deep copy of this object */ T deepCopy(); /** * Returns a shallow copy of this object. * @return a shallow copy of this object */ T shallowCopy(); /** * Indicates whether this VMF object is equal to the specified object. * It uses VMFs equals implementation which compares all properties unless * they are ignored explicitly via annotation. * @param o object to compare * @return {@code } if equals; {@code false} otherwise */ @Override boolean equals(Object o); /** * Returns the hash-code for this VMF object. It uses VMFs hashCode * implementation which takes all properties into account unless * they are ignored explicitly via annotation. * @return {@code } if equals; {@code false} otherwise */ @Override int hashCode(); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy